fullcontact 0.14.0 → 0.15.0

data/.travis.yml

@@ -1,9 +1,10 @@
 language: ruby
 
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
 
 gemfile:
   - Gemfile

data/README.md

@@ -9,8 +9,8 @@ A Ruby wrapper for the [FullContact API](http://www.fullcontact.com/)
 
 Changes
 -------
-- 0.14.0
-    - Remove `plissken` gem to support Rails 5 (#42)
+- 0.15.0 - Add header-based auth via `config.auth_type = :header` control.
+- 0.14.0 - Remove `plissken` gem to support Rails 5 (#42)
 - 0.13.0
     - Raise `ArgumentError` if query by Facebook ID/username is used.
     - Remove deprecated messages.
@@ -45,7 +45,7 @@ Usage Examples
     FullContact.configure do |config|
         config.api_key = 'fullcontact_api_key_goes_here'
     end
-	
+
     # Get information about an email address
     person = FullContact.person(email: 'bart@fullcontact.com')
 ```
@@ -64,21 +64,30 @@ But you can also turn it into a normal hash
     person.to_hash['contact_info']['family_name']
      => "Lorang"
 ```
+Authentication is done through query parameters by default. If you want to use headers instead:
+
+```ruby
+    # This could go in an initializer
+    FullContact.configure do |config|
+        config.api_key = 'fullcontact_api_key_goes_here'
+        config.auth_type = :headers # :header or :query
+    end
+```
 
 There's other ways you can query the Person API:
 ```ruby
     # Get information about an email address, organized by hashes vs. lists
     person2 = FullContact.person(email: 'bart@fullcontact.com', style: 'dictionary')
-    
+
     # You can pass in any arbitrary parameters the Person API supports
     person3 = FullContact.person(email: 'bart@fullcontact.com', style: 'dictionary', webhookUrl: 'https://...')
-    
+
     # Get information about a twitter handle
     person4 = FullContact.person(twitter: "bartlorang")
-    
+
     # Get information from a phone number
     person6 = FullContact.person(phone:13037170414)
-    
+
     # Get information about a twitter and ensure a 30s socket open timeout and a 15s socket read timeout
     # Can throw a Faraday::Error::TimeoutError if timeouts are exceeded
     person7 = FullContact.person({:twitter => "bartlorang"}, {:request => {:timeout => 15, :open_timeout => 30}})
@@ -94,7 +103,7 @@ Response formats can more closely mirror FullContact's APIs by disabling snake_c
 
     person8 = FullContact.person(email: "bart@fullcontact.com")
 
-    => #<Hashie::Mash contactInfo=#<Hashie::Mash chats=[#<Hashie::Mash client="gtalk" handle="lorangb@gmail.com">, 
+    => #<Hashie::Mash contactInfo=#<Hashie::Mash chats=[#<Hashie::Mash client="gtalk" handle="lorangb@gmail.com">,
     #<Hashie::Mash client="skype" handle="bart.lorang">] familyName="Lorang" fullName="Bart Lorang" givenName="Bart...
 ```
 
@@ -107,7 +116,7 @@ You can also query the Company API
      => "FullContact Inc."
 ```
 
-	
+
 Contributions
 -------------
 A full list of contributors can be found in

data/lib/fullcontact/configuration.rb

@@ -8,6 +8,7 @@ module FullContact
     VALID_OPTIONS_KEYS = [
         :adapter,
         :api_key,
+        :auth_type,
         :endpoint,
         :format,
         :skip_rubyize,
@@ -27,6 +28,9 @@ module FullContact
     # By default, don't set an application key
     DEFAULT_API_KEY = nil
 
+    # By default, use query parameters
+    DEFAULT_AUTH_TYPE = :query
+
     # The endpoint that will be used to connect if none is set
     #
     DEFAULT_ENDPOINT = 'https://api.fullcontact.com/v2/'.freeze
@@ -50,6 +54,8 @@ module FullContact
 
     DEFAULT_GATEWAY = nil
 
+    AUTH_HEADER_NAME = 'X-FullContact-APIKey'.freeze
+
     # @private
     attr_accessor *VALID_OPTIONS_KEYS
 
@@ -74,6 +80,7 @@ module FullContact
     def reset
       self.adapter = DEFAULT_ADAPTER
       self.api_key = DEFAULT_API_KEY
+      self.auth_type = DEFAULT_AUTH_TYPE
       self.endpoint = DEFAULT_ENDPOINT
       self.format = DEFAULT_FORMAT
       self.skip_rubyize = DEFAULT_SKIP_RUBYIZE

data/lib/fullcontact/request.rb

@@ -10,10 +10,16 @@ module FullContact
 
     # Perform an HTTP request
     def request(method, path, options, raw=false, faraday_options={})
-      options[:apiKey] = FullContact.options[:api_key]
+      if FullContact.options[:auth_type] == :query
+        options[:apiKey] = FullContact.options[:api_key]
+      end
 
       response = connection(raw, faraday_options).send(method) do |request|
         request.url(formatted_path(path), options)
+
+        if FullContact.options[:auth_type] == :header
+          request.headers[FullContact::Configuration::AUTH_HEADER_NAME] = FullContact.options[:api_key]
+        end
       end
 
       raw ? response : response.body

data/lib/fullcontact/version.rb

@@ -1,3 +1,3 @@
 module FullContact
-  VERSION = '0.14.0'
+  VERSION = '0.15.0'
 end

data/spec/fullcontact_spec.rb

@@ -20,13 +20,41 @@ describe FullContact do
       stub_get("person.json").
           with(:query => {:apiKey => "api_key", :twitter => "brawtest"}).
           to_return(:body => fixture("person.json"), :headers => {:content_type => "application/json; charset=utf-8"})
+
+      stub_get("person.json").
+          with(:query => {:email => "brawest@gmail.com"})
+    end
+
+    context "when using query auth type" do
+
+      before do
+        FullContact.configure do |config|
+          config.auth_type = :query
+        end
+      end
+
+      it "should get the correct resource" do
+        FullContact.person(email: "brawest@gmail.com")
+        a_get("person.json")
+            .with(:query => {:apiKey => "api_key", :email => "brawest@gmail.com"})
+            .should have_been_made
+      end
     end
 
-    it "should get the correct resource" do
-      FullContact.person(email: "brawest@gmail.com")
-      a_get("person.json")
-          .with(:query => {:apiKey => "api_key", :email => "brawest@gmail.com"})
-          .should have_been_made
+    context "when using header auth type" do
+
+      before do
+        FullContact.configure do |config|
+          config.auth_type = :header
+        end
+      end
+
+      it "should get the correct resource" do
+        FullContact.person(email: "brawest@gmail.com")
+        a_get("person.json")
+            .with(:query => {:email => "brawest@gmail.com"}, :headers => {:'X-Fullcontact-Apikey'=>'api_key'})
+            .should have_been_made
+      end
     end
 
     it "should return the same results as a client by email" do

data/spec/ruby_fullcontact/api_spec.rb

@@ -30,6 +30,7 @@ describe FullContact::API do
       before do
         @configuration = {
             :api_key => 'api_key',
+            :auth_type => :headers,
             :adapter => :typhoeus,
             :endpoint => 'http://tumblr.com/',
             :gateway => 'apigee-1111.apigee.com',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fullcontact
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &70240872599500 !ruby/object:Gem::Requirement
+  requirement: &70168063820700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70240872599500
+  version_requirements: *70168063820700
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70240872599000 !ruby/object:Gem::Requirement
+  requirement: &70168063820120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70240872599000
+  version_requirements: *70168063820120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70240872598420 !ruby/object:Gem::Requirement
+  requirement: &70168063819600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70240872598420
+  version_requirements: *70168063819600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70240872597600 !ruby/object:Gem::Requirement
+  requirement: &70168063819080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.1'
   type: :development
   prerelease: false
-  version_requirements: *70240872597600
+  version_requirements: *70168063819080
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70240872597140 !ruby/object:Gem::Requirement
+  requirement: &70168063818600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70240872597140
+  version_requirements: *70168063818600
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70240872596660 !ruby/object:Gem::Requirement
+  requirement: &70168063818140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '1.6'
   type: :development
   prerelease: false
-  version_requirements: *70240872596660
+  version_requirements: *70168063818140
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70240872596120 !ruby/object:Gem::Requirement
+  requirement: &70168063817680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '0.7'
   type: :development
   prerelease: false
-  version_requirements: *70240872596120
+  version_requirements: *70168063817680
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70240872595560 !ruby/object:Gem::Requirement
+  requirement: &70168063833520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,10 +101,10 @@ dependencies:
         version: '4.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70240872595560
+  version_requirements: *70168063833520
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70240872594780 !ruby/object:Gem::Requirement
+  requirement: &70168063832800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -112,10 +112,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70240872594780
+  version_requirements: *70168063832800
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70240872610680 !ruby/object:Gem::Requirement
+  requirement: &70168063832260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -123,7 +123,7 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70240872610680
+  version_requirements: *70168063832260
 description: A Ruby wrapper for the FullContact API
 email:
 - support@fullcontact.com
@@ -181,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3898038741122446836
+      hash: 754980760843219828
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: