# SeventeenMon

**Repository Path**: oscstudio/SeventeenMon

## Basic Information

- **Project Name**: SeventeenMon
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2017-02-21
- **Last Updated**: 2022-08-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SeventeenMon

SeventeenMon simply help you find location by IP address. Data is totally based on [IPIP.NET](https://www.ipip.net/product/client.html).

Version >= 2.0 only support ipdb format.

## Compatibility

I have tested it on Ruby 2.1.10, 2.4.6, 2.6.2. Other versions are not tested but should work on well. Please contact me if not.

## Installation

Add this line to your application's Gemfile:

    gem 'seventeen_mon', git: "https://github.com/BlindingDark/SeventeenMon"

And then execute:

    $ bundle

This project is forked from [mycolorway/SeventeenMon](https://github.com/mycolorway/SeventeenMon).
Install by gem will be used the mycolorway's **old version**.

I am considering releasing a new gem package, but I didn't think of a good name. Please contact me if you have some good idea, thanks.

## Usage

### In Ruby

```(ruby)
SM.find_by_ip "119.75.216.20"
# => {:country=>"中国", :province=>"北京", :city=>"北京"}

SM.find_by_address "http://taobao.com"
# => {:country=>"中国", :province=>"浙江", :city=>"杭州"}
```

### In Command Line

```(bash)
$ seventeen ip 119.75.216.20
Country:   中国
Province:  北京
City:      北京


$ seventeen seventeen address http://taobao.com
Country:   中国
Province:  浙江
City:      杭州
```

## TODO

* [X] More metadata info
* [ ] Support paid version format

## Contributing

1. Fork it ( http://github.com/BlindingDark/SeventeenMon/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

## Thanks

[高春辉 Paul Gao](https://www.ipip.net) - for his awesome data.