pointpin 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b450f35c3da0837208c3181ed16b7a2d81ae53e3
+  data.tar.gz: 94450c6a4ea22c51d1906f739fa7ee65332a1d05
+SHA512:
+  metadata.gz: 8f9620b68a98edfda303d2682c2c9fdc45543656d120565ed8a49cc0b2456b11bd7687187461ec040018ddb1f77ef460c0468e316b3f14c39603d5b81b2b15ec
+  data.tar.gz: 168904cb5dcdc3fa56d8032b85d278ca5ed8da61913a99d937e0032f349c1bad9b21f8b221a1c3d032face52e042cdb445662e7adace04a0581a4999bc032446

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Flanagan
+
+MIT License
+
+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,43 @@
+# Pointp.in
+
+[Pointp.in](https://pointp.in) API wrapper in Ruby.
+
+## Installation
+
+`gem install pointpin`
+
+or in your `Gemfile`
+
+```ruby
+gem 'pointpin'
+```
+
+## Usage
+
+Make sure you require the library.
+
+```ruby
+require 'pointpin'
+```
+
+You will need to set your API key before you can make requests to the [Pointp.in](https://pointp.in) API.
+
+```ruby
+Pointpin.api_key = 'this-is-your-api-key'
+```
+
+You can then make requests to the `Pointpin.locate(ip_address)` method.
+
+Get location data for an IP address:
+
+```ruby
+location = Pointpin.locate('55.111.555.555')
+```
+
+Please refer to the [pointp.in docs](https://pointp.in/docs/get-started) for more information on the full response properties.
+
+The gem uses [Faraday](https://github.com/lostisland/faraday) for HTTP requests. It uses `Net::HTTP` by default, but changing the adapter is pretty straightforward.
+
+## Copyright
+
+Copyright (c) 2014 Brian Flanagan. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--backtrace']
+end
+
+task :default => :spec

data/lib/pointpin.rb

@@ -0,0 +1,40 @@
+require 'pointpin/configuration'
+require 'pointpin/version'
+
+require 'hashie'
+require 'multi_json'
+require 'faraday'
+
+module Pointpin
+  extend Configuration
+
+  self.default_params = {}
+
+  class << self
+    def locate(ip)
+      pointpin_url = "#{ Pointpin.api_endpoint }/#{ Pointpin.api_key }/json/#{ ip }"
+
+      pointpin_response = get(pointpin_url)
+
+      if pointpin_response.success?
+        return Hashie::Mash.new(MultiJson.load(pointpin_response.body))
+      end
+    end
+    
+    def connection
+      @connection ||= Faraday.new
+    end
+    
+    def connection=(connection)
+      @connection = connection
+    end
+
+    private
+
+    def get(path, params = {})
+      params = Pointpin.default_params.merge(params || {})
+
+      connection.get(path, params)
+    end
+  end
+end

data/lib/pointpin/configuration.rb

@@ -0,0 +1,29 @@
+module Pointpin
+  module Configuration
+    # Default API endpoint
+    DEFAULT_API_ENDPOINT = 'http://geo.pointp.in'
+
+    # Pointpin API endpoint
+    attr_writer :api_endpoint
+
+    # API key
+    attr_writer :api_key
+
+    # Default parameters
+    attr_accessor :default_params
+    
+    def configure
+      yield self
+    end
+
+    # API endpoint
+    def api_endpoint
+      @api_endpoint ||= DEFAULT_API_ENDPOINT
+    end
+
+    # API key
+    def api_key
+      @api_key
+    end
+  end
+end

data/lib/pointpin/version.rb

@@ -0,0 +1,3 @@
+module Pointpin
+  VERSION = "1.0.0"
+end

data/pointpin.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pointpin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pointpin"
+  spec.version       = Pointpin::VERSION
+  spec.authors       = ["Brian Flanagan"]
+  spec.email         = ["brian@coralmade.com"]
+  spec.homepage      = "https://github.com/coralmade/pointpin-ruby"
+  spec.summary       = %q{Pointp.in API wrapper in Ruby}
+  spec.description   = %q{Pointp.in API wrapper in Rub}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rspec')
+  spec.add_development_dependency('vcr')
+  spec.add_development_dependency('typhoeus')
+
+  spec.add_dependency('faraday')
+  spec.add_dependency('multi_json')
+  spec.add_dependency('hashie')
+end

data/spec/cassettes/location_for_ip.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://geo.pointp.in/this-is-a-valid-api-key/json/55.111.555.555
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.0
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '222'
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      Last-Modified:
+      - Wed, 16 Jul 2014 08:42:12 GMT
+      X-Content-Type-Options:
+      - nosniff
+      X-Powered-By:
+      - Phusion Passenger 4.0.45
+      Date:
+      - Wed, 16 Jul 2014 08:42:12 GMT
+      Server:
+      - nginx/1.6.0 + Phusion Passenger 4.0.45
+    body:
+      encoding: UTF-8
+      string: '{"ip":"55.111.555.555","continent_code":"EU","country_code":"IE","country_name":"Ireland","region_name":"Dublin
+        City","city_name":"Dublin","postcode":null,"latitude":53.3331,"longitude":-6.2489,"time_zone":"Europe/Dublin"}'
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://geo.pointp.in/this-is-a-valid-api-key/json/55.111.555.555
+  recorded_at: Wed, 16 Jul 2014 08:42:12 GMT
+recorded_with: VCR 2.9.2

data/spec/pointpin/configuration_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Pointpin::Configuration do
+  describe '.configure' do
+    it 'should have default attributes' do
+      Pointpin.configure do |configuration|
+        configuration.api_endpoint.should eql(Pointpin::Configuration::DEFAULT_API_ENDPOINT)
+        configuration.api_key.should be_nil
+      end
+    end
+  end
+end

data/spec/pointpin/pointpin_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Pointpin do
+  describe '.default_params' do
+    it "defaults to an empty hash" do
+      Pointpin.default_params.should == {}
+    end
+  end
+
+  describe '.locate' do
+    before :each do
+      Pointpin.api_key = 'this-is-a-valid-api-key'
+    end
+
+    it 'should return a location for a given IP address' do
+      VCR.use_cassette('location_for_ip', record: :once) do
+        location = Pointpin.locate('55.111.555.555')
+        location.should_not be_nil
+        location.latitude.should == 53.3331
+        location.longitude.should == -6.2489
+      end
+    end
+
+    context 'unit tests' do
+      let(:faraday)  { double 'Faraday', get: response }
+      let(:response) { double 'Response', success?: true, body: '{}' }
+
+      before :each do
+        stub_const 'Faraday', double(new: faraday)
+
+        Pointpin.stub(api_key: 'api-key', connection: faraday)
+      end
+
+      context 'without default parameters' do
+        before :each do
+          Pointpin.stub(default_params: {})
+        end
+
+        it "sends a standard request" do
+          faraday.should_receive(:get).with(
+            'http://geo.pointp.in/api-key/json/1.2.3.4', {}
+          ).and_return(response)
+
+          Pointpin.locate('1.2.3.4')
+        end
+      end
+    end
+  end
+end

data/spec/pointpin/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Pointpin::VERSION' do
+  it 'should be the correct version' do
+    Pointpin::VERSION.should == '1.0.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+require 'rspec'
+require 'pointpin'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+require 'vcr'
+require 'typhoeus/adapters/faraday'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/cassettes'
+  c.hook_into :typhoeus
+  c.allow_http_connections_when_no_cassette = false
+end
+
+Faraday.default_adapter = :typhoeus
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Pointpin.api_key = nil
+  end
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: pointpin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brian Flanagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: Pointp.in API wrapper in Rub
+email:
+- brian@coralmade.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pointpin.rb
+- lib/pointpin/configuration.rb
+- lib/pointpin/version.rb
+- pointpin.gemspec
+- spec/cassettes/location_for_ip.yml
+- spec/pointpin/configuration_spec.rb
+- spec/pointpin/pointpin_spec.rb
+- spec/pointpin/version_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Pointp.in API wrapper in Ruby
+test_files:
+- spec/cassettes/location_for_ip.yml
+- spec/pointpin/configuration_spec.rb
+- spec/pointpin/pointpin_spec.rb
+- spec/pointpin/version_spec.rb
+- spec/spec_helper.rb