pipl-api 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b7034057d20dee2ed1589888d24b6ae0b70392b
-  data.tar.gz: 8d511aee71ba4335ab2a953177befd73d8282194
+  metadata.gz: c697e18bae4c2053ae0748880ec12f9158a44139
+  data.tar.gz: cd14044050efd45485cdd96ad1394aac3dcd4b71
 SHA512:
-  metadata.gz: 9fc1f72593508d8019e80b0b998c59606fe1e86d017f45a1f88dacd2f4feee42b9234b6e23e98e8f302acd78a40fe4a894a34ab6c5c5c98d94fb37ee4475de2e
-  data.tar.gz: 2a3b2bd466848d4bef44e20e5df265b71c34bcf4825a7e49b5bb32e965cc8c75a7efaf4ce83f2948810de146c97387cadfef9665b9a3b4b00d1e58ad0f237030
+  metadata.gz: d72a343c5f3da146421e3a611ccf2dbc3477ade8a23865c806d8d291f44ce010525712b77cf671151bc6e58963265b7031f4284b88e105cabc26c6d8ea017a22
+  data.tar.gz: c7762721133551f86bc215eaa66d12f8a8a7286947ddcdbc46849a0c46dcb51bcc10091f59ea63e55a81bbeec01fcf6d648f2d3127f7ef88a9d939f7a0d95ee8

data/lib/pipl.rb

@@ -1,5 +1,8 @@
 require "rest_client"
+require "multi_json"
+
 require_relative "pipl/api"
+require_relative "pipl/client"
 
 module Pipl
   # Your code goes here...

data/lib/pipl/api.rb

@@ -1,13 +1,9 @@
 require_relative "api/version"
 require_relative "api/request"
+require_relative "api/response"
+
 module Pipl
   module API
-    def self.api_key=(value)
-      @api_key = value
-    end
 
-    def self.api_key
-      @api_key
-    end
   end
 end

data/lib/pipl/api/request.rb

@@ -1,5 +1,4 @@
 require_relative "request/name"
-require_relative "request/get"
 
 module Pipl
   module API
@@ -19,7 +18,7 @@ module Pipl
       end
 
       def call(verb)
-        self.class.const_get(verb.capitalize).new(uri).call!(parameters)
+        RestClient.send(verb, uri, params: @parameters)
       end
 
       def uri
@@ -29,10 +28,6 @@ module Pipl
       def protocol
          "#{@protocol}://"
       end
-
-      def parameters
-        Pipl::API.api_key ? @parameters.merge(key: Pipl::API.api_key) : @parameters
-      end
     end
   end
 end

data/lib/pipl/api/request/name.rb

@@ -4,14 +4,17 @@ module Pipl
       class Name
         def initialize(raw, options = {})
           @raw = raw
+          @options = options
         end
 
         def call
           request.call("get")
         end
 
+        private
+
         def request
-          Request.new("name", raw_name: @raw)
+          Request.new("name", raw_name: @raw, key: @options[:key] )
         end
       end
     end

data/lib/pipl/api/response.rb

@@ -0,0 +1,27 @@
+require_relative "response/person"
+require_relative "response/name"
+require_relative "response/age"
+require_relative "response/location"
+require_relative "response/gender"
+
+module Pipl
+  module API
+    class Response
+      attr_reader :data
+      attr_reader :status
+      attr_reader :warnings
+      attr_reader :person
+
+      def initialize(raw)
+        @data = MultiJson.load(raw)
+        @status = @data.delete("@http_status_code")
+        @warnings = @data.delete("warnings")
+        @person = Person.new(@data)
+      end
+
+      def ok?
+        status == 200
+      end
+    end
+  end
+end

data/lib/pipl/api/response/age.rb

@@ -0,0 +1,28 @@
+module Pipl
+  module API
+    class Response
+      class Age
+        attr_reader :from, :to
+        attr_reader :estimation
+
+        def initialize(age)
+          @from = age["from_age"]
+          @to = age["to_age"]
+          @estimation = age["estimated_percent"].to_f / 100
+        end
+
+        def to_range
+          @from..@to
+        end
+
+        def to_hash
+          {
+            range: to_range,
+            estimation: estimation
+          }
+        end
+        alias_method :to_h, :to_hash
+      end
+    end
+  end
+end

data/lib/pipl/api/response/gender.rb

@@ -0,0 +1,23 @@
+module Pipl
+  module API
+    class Response
+      class Gender
+        attr_reader :code
+        attr_reader :estimation
+
+        def initialize(gender)
+          @code = gender.first
+          @estimation = gender.last
+        end
+
+        def to_hash
+          {
+            code: code,
+            estimation: estimation
+          }
+        end
+        alias_method :to_h, :to_hash
+      end
+    end
+  end
+end

data/lib/pipl/api/response/location.rb

@@ -0,0 +1,32 @@
+module Pipl
+  module API
+    class Response
+      class Location
+        attr_reader :code, :state, :country
+        attr_reader :estimation
+
+        def initialize(location)
+          @code = location["country"]
+          if location["display"].include?(",")
+            @state = location["display"].split(", ").first
+            @country = location["display"].split(", ").last
+          else
+            @country = location["display"]
+          end
+          @estimation = location["estimated_percent"].to_f / 100
+        end
+
+        def to_hash
+          {
+            code: code,
+            state: state,
+            country: country,
+            estimation: estimation
+          }
+        end
+        alias_method :to_h, :to_hash
+
+      end
+    end
+  end
+end

data/lib/pipl/api/response/name.rb

@@ -0,0 +1,27 @@
+module Pipl
+  module API
+    class Response
+      class Name
+        attr_reader :first
+        attr_reader :middle
+        attr_reader :last
+
+        def initialize(name)
+          @first = name["first"]
+          @middle = name["middle"]
+          @last = name["last"]
+        end
+
+        def to_hash
+          {
+            first: first,
+            middle: middle,
+            last: last
+          }
+        end
+        alias_method :to_h, :to_hash
+
+      end
+    end
+  end
+end

data/lib/pipl/api/response/person.rb

@@ -0,0 +1,44 @@
+module Pipl
+  module API
+    class Response
+      class Person
+        attr_reader :name
+        attr_reader :full_names
+        attr_reader :nicknames
+        attr_reader :spellings
+        attr_reader :translations
+        attr_reader :locations
+        attr_reader :ages
+        attr_reader :gender
+        attr_reader :estimated_world_persons_count
+
+        def initialize(data)
+          @name = Name.new(data["name"])
+          @full_names = Name.new(data["full_names"]) unless data["full_names"] == {}
+          @nicknames = Name.new(data["nicknames"]) unless data["nicknames"] == {}
+          @spellings = Name.new(data["spellings"]) unless data["spellings"] == {}
+          @translations = data["translations"] unless data["translations"] == {}
+          @gender = Gender.new(data["gender"])
+          @locations = data["top_locations"].map { |location| Location.new(location) }
+          @ages = data["top_ages"].map { |age| Age.new(age) }
+          @estimated_world_persons_count = data["estimated_world_persons_count"]
+        end
+
+        def to_hash
+          {
+            name: name.to_hash,
+            full_names: full_names.to_hash,
+            nicknames: nicknames.to_hash,
+            spellings: spellings.to_hash,
+            translations: translations,
+            gender: gender.to_hash,
+            locations: locations.map(&:to_hash),
+            ages: ages.map(&:to_hash),
+            estimated_world_persons_count: estimated_world_persons_count
+          }
+        end
+        alias_method :to_h, :to_hash
+      end
+    end
+  end
+end

data/lib/pipl/api/version.rb

@@ -1,5 +1,5 @@
 module Pipl
   module API
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/pipl/client.rb

@@ -0,0 +1,15 @@
+require_relative "client/name"
+
+module Pipl
+  class Client
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def name(raw_name)
+      Name.new(self, raw_name).response
+    end
+  end
+end

data/lib/pipl/client/name.rb

@@ -0,0 +1,13 @@
+module Pipl
+  class Client
+    class Name
+      def initialize(client, name)
+        @request = API::Request::Name.new(name, key: client.key)
+      end
+
+      def response
+        @response ||= API::Response.new(@request.call)
+      end
+    end
+  end
+end

data/test/lib/pipl/api/request_test.rb

@@ -37,9 +37,7 @@ class TestPiplAPIRequest < Minitest::Test
   end
 
   def test_call
-    get = MiniTest::Mock.new
-    get.expect :call!, "foo", [{}]
-    Pipl::API::Request::Get.stub :new, get do
+    RestClient.stub :get, "foo" do
       expected = "foo"
       actual = @request.call("get")
       assert_equal(expected, actual)

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: pipl-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kurtis Rainbolt-Greene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -158,15 +172,21 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/pipl/api/request/get.rb
 - lib/pipl/api/request/name.rb
 - lib/pipl/api/request.rb
+- lib/pipl/api/response/age.rb
+- lib/pipl/api/response/gender.rb
+- lib/pipl/api/response/location.rb
+- lib/pipl/api/response/name.rb
+- lib/pipl/api/response/person.rb
+- lib/pipl/api/response.rb
 - lib/pipl/api/version.rb
 - lib/pipl/api.rb
+- lib/pipl/client/name.rb
+- lib/pipl/client.rb
 - lib/pipl-api.rb
 - lib/pipl.rb
 - test/helper.rb
-- test/lib/pipl/api/request/get_test.rb
 - test/lib/pipl/api/request_test.rb
 - test/lib/pipl/api/version_test.rb
 - test/lib/pipl/api_test.rb
@@ -198,7 +218,6 @@ specification_version: 4
 summary: An interface for the Pipl API
 test_files:
 - test/helper.rb
-- test/lib/pipl/api/request/get_test.rb
 - test/lib/pipl/api/request_test.rb
 - test/lib/pipl/api/version_test.rb
 - test/lib/pipl/api_test.rb

data/lib/pipl/api/request/get.rb

@@ -1,19 +0,0 @@
-module Pipl
-  module API
-    class Request
-      class Get
-        def initialize(uri)
-          @uri = uri
-        end
-
-        def call!(parameters = {})
-          begin
-            RestClient.get(@uri, params: parameters)
-          rescue => e
-            raise e.response
-          end
-        end
-      end
-    end
-  end
-end

data/test/lib/pipl/api/request/get_test.rb

@@ -1,15 +0,0 @@
-require "helper"
-
-class TestPiplAPIRequestGet < Minitest::Test
-  def setup
-    @get = Pipl::API::Request::Get.new("http://www.foo.com/var")
-  end
-
-  def test_call!
-    expected = "http://www.foo.com/var"
-    RestClient.stub :get, "http://www.foo.com/var" do
-      actual = @get.call!
-      assert_equal(expected, actual)
-    end
-  end
-end