pipl-lite 0.1.0

data/lib/pipl-lite.rb

@@ -0,0 +1,2 @@
+
+require 'pipl/lite'

data/lib/pipl/lite.rb

@@ -0,0 +1,47 @@
+
+
+require 'uri'
+require 'httparty'
+module Pipl
+  class Lite
+    include HTTParty
+
+    class NotConfiguredError < StandardError; end
+    class ResponseError < StandardError; end
+
+    base_uri 'https://api.pipl.com'
+    @@configured = false
+
+    def self.configure(key:)
+      @@pipl_key = key
+      @@configured = true
+    end
+
+    def self.key
+      @@pipl_key
+    end
+
+    def self.reset_key!
+      @@pipl_key = nil
+      @@configured = false
+    end
+
+    def self.search(args={})
+      raise NotConfiguredError unless @@configured
+      args[:key] = key
+      uri = URI(base_uri + '/search')
+      uri.query = URI.encode_www_form(args)
+      response = get(uri.to_s)
+      case response.code
+      when 200..299
+        # Return the top 0-5 matches, sorted by score in descending order:
+        JSON.parse(response.body, symbolize_names: true)[:possible_persons]
+          .select{ |person| person[:@match] > 0 }
+          .sort_by{ |x| x[:@match] }
+          .reverse[0..4]
+      else
+        raise ResponseError.new(response)
+      end
+    end
+  end
+end

data/pipl-lite.gemspec

@@ -0,0 +1,25 @@
+
+Gem::Specification.new do |spec|
+  spec.name        = 'pipl-lite'
+  spec.version     = '0.1.0'
+  spec.authors     = ['John Drago']
+  spec.email       = 'jdrago.999@gmail.com'
+  spec.homepage    = 'https://github.com/jdrago999/pipl-lite'
+  spec.summary     = 'Search Pipl API, the simple way'
+  spec.description = 'Search Pipl API, the simple way'
+  spec.required_rubygems_version = '>= 1.3.6'
+
+  spec.files         = Dir['**/*'].keep_if { |file| File.file?(file) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'shoulda-matchers'
+  spec.add_development_dependency 'simplecov'
+
+  spec.add_dependency 'httparty'
+
+end

data/spec/pipl/lite_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Pipl::Lite do
+  before do
+    described_class.reset_key!
+  end
+  describe '.configure(key:)' do
+    it 'configures the Pipl::Lite package' do
+      key = SecureRandom.uuid
+      described_class.configure(key: key)
+      expect(described_class.key).to eq(key)
+    end
+  end
+  describe '.search(args={})' do
+    context 'when it is not yet confiured' do
+      it 'raises an exception' do
+        expect{described_class.search(raw_name: 'Clark Kent')}.to raise_error Pipl::Lite::NotConfiguredError
+      end
+    end
+    context 'when it has been configured' do
+      before do
+        @key = SecureRandom.uuid
+        described_class.configure(key: @key)
+      end
+      it 'searches with the keys provided' do
+        expect(described_class).to receive(:get).with('https://api.pipl.com/search?raw_name=Clark+Kent&key=%s' % @key) do
+          OpenStruct.new(
+            code: 200,
+            body: {
+              possible_persons: [
+                {
+                  :@match => 0.5
+                }
+              ]
+            }.to_json
+          )
+        end
+        described_class.search(raw_name: 'Clark Kent')
+      end
+      context 'when it receives an error response' do
+        before do
+          expect(described_class).to receive(:get) do
+            OpenStruct.new(code: 401)
+          end
+        end
+        it 'raises an exception' do
+        expect{described_class.search(raw_name: 'Clark Kent')}.to raise_error Pipl::Lite::ResponseError
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/'
+end
+SimpleCov.minimum_coverage 100
+require File.expand_path("../../lib/pipl-lite", __FILE__)
+require 'rspec'
+require 'shoulda-matchers'
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+  end
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: pipl-lite
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Drago
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  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: simplecov
+  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: httparty
+  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: Search Pipl API, the simple way
+email: jdrago.999@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- coverage/assets/0.10.2/application.css
+- coverage/assets/0.10.2/application.js
+- coverage/assets/0.10.2/colorbox/border.png
+- coverage/assets/0.10.2/colorbox/controls.png
+- coverage/assets/0.10.2/colorbox/loading.gif
+- coverage/assets/0.10.2/colorbox/loading_background.png
+- coverage/assets/0.10.2/favicon_green.png
+- coverage/assets/0.10.2/favicon_red.png
+- coverage/assets/0.10.2/favicon_yellow.png
+- coverage/assets/0.10.2/loading.gif
+- coverage/assets/0.10.2/magnify.png
+- coverage/assets/0.10.2/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.10.2/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.10.2/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.10.2/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.10.2/smoothness/images/ui-icons_222222_256x240.png
+- coverage/assets/0.10.2/smoothness/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.10.2/smoothness/images/ui-icons_454545_256x240.png
+- coverage/assets/0.10.2/smoothness/images/ui-icons_888888_256x240.png
+- coverage/assets/0.10.2/smoothness/images/ui-icons_cd0a0a_256x240.png
+- coverage/index.html
+- lib/pipl-lite.rb
+- lib/pipl/lite.rb
+- pipl-lite.gemspec
+- spec/pipl/lite_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jdrago999/pipl-lite
+licenses: []
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Search Pipl API, the simple way
+test_files:
+- spec/pipl/lite_spec.rb
+- spec/spec_helper.rb