mxmnd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56a961e68bbf46c972d8cf3d95d76fc04de49f86
+  data.tar.gz: c31b670924998c08ef9ce7a42d9d72260bca7db4
+SHA512:
+  metadata.gz: ff6fc0193225dfa1758eeaacc6eb596a1fc4b9b785ffa322973b57d472ecf58488471bc1f8008714ed1b671bebca73d5006081da3e48c2e5bc4e91586b97414d
+  data.tar.gz: df25fff1a04246fc4700d04f3b7801075a2b41a691732eeb04d2c20eb69831a981e28e2bdb2f882b62fa2766d1571033eec7093e091f8ce90a78c4f8c9a55b75

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mxmnd.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Valentin Vasilyev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,33 @@
+# Mxmnd
+
+Minimalistic MaxMind API wrapper for Ruby.
+
+`Faraday` is the only runtime dependency.
+
+Supports only `#city` API call. API compatible with `Geoip2.city`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mxmnd'
+```
+
+## Usage
+
+```ruby
+Mxmnd.city('8.8.8.8')
+```
+
+If you want to use faraday options, you can pass them as a second parameter:
+
+```ruby
+Mxmnd.city('8.8.8.8', request: {timeout: 1})
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mxmnd"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mxmnd.rb

@@ -0,0 +1,76 @@
+require 'json'
+require 'faraday'
+
+module Mxmnd
+  VERSION = '0.1.0'
+  BASE_URL = 'https://geoip.maxmind.com'.freeze
+  BASE_PATH = '/geoip/v2.1'.freeze
+  USER_ID_ENV_KEY = 'MAX_MIND_USER_ID'.freeze
+  LICENSE_KEY_ENV_KEY = 'MAX_MIND_LICENSE_KEY'.freeze
+
+  class << self
+    def city(ip, faraday_options = {})
+      raise BadRequest.new('IP_ADDRESS_REQUIRED', 'You have not passed IP address.') unless ip
+      path = "/city/#{ip}"
+      get(connection(faraday_options), path)
+    end
+
+    private
+
+    def connection(faraday_options = {})
+      @connection ||= Faraday.new(BASE_URL, faraday_options)
+    end
+
+    def get(connection, path)
+      connection.basic_auth(ENV[USER_ID_ENV_KEY], ENV[LICENSE_KEY_ENV_KEY])
+      full_path = "#{BASE_PATH}#{path}"
+      response = connection.get(full_path)
+      raise_if_error!(response)
+      JSON.parse(response.body)
+    end
+
+    def raise_if_error!(response)
+      case response.status
+      when 400 then raise_client_error(response, BadRequest)
+      when 401 then raise_client_error(response, Unauthorized)
+      when 402 then raise_client_error(response, PaymentRequired)
+      when 403 then raise_client_error(response, Forbidden)
+      # MaxMind will only return 503, but just in case
+      when 500..599 then raise ServerError
+      end
+    end
+
+    def raise_client_error(response, klass)
+      response = JSON.parse(response.body)
+      code, error = response.values_at(*%w(code error))
+      raise klass.new(code, error)
+    end
+  end
+
+  class ClientError < StandardError
+    attr_reader :code
+
+    def initialize(code, error)
+      @code = code
+      super(error)
+    end
+  end
+
+  class Unauthorized < ClientError
+    def initialize(code, error)
+      msg = "#{error} Set valid #{USER_ID_ENV_KEY} and #{LICENSE_KEY_ENV_KEY} environmental variables to authenticate with MaxMind API." 
+      super(code, msg)
+    end
+  end
+
+  class BadRequest < ClientError; end
+  class PaymentRequired < ClientError; end
+  class NotFound < ClientError; end
+  class Forbidden < ClientError; end
+
+  class ServerError < StandardError
+    def initialize
+      super('MaxMind service is not available (503)')
+    end
+  end
+end

data/mxmnd.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mxmnd'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mxmnd"
+  spec.version       = Mxmnd::VERSION
+  spec.authors       = ["Valentin Vasilyev"]
+  spec.email         = ["valentin.vasilyev@outlook.com"]
+
+  spec.summary       = %q{Minimalistic MaxMind API wrapper for Ruby}
+  spec.homepage      = "https://github.com/Valve/mxmnd"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "faraday"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: mxmnd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Valentin Vasilyev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- valentin.vasilyev@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mxmnd.rb
+- mxmnd.gemspec
+homepage: https://github.com/Valve/mxmnd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Minimalistic MaxMind API wrapper for Ruby
+test_files: []