authy 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a7a9d75bf6b712ad35e60eea16462aa4d97bea5
-  data.tar.gz: f56ddadf3459645a46cb2d2b13ad83fa1adf3a87
+  metadata.gz: bb9d7de576c3afc925818fc8b89d5e67aac65fa9
+  data.tar.gz: 6a5313143bd01165c1b7ab33553b77a7ade3867b
 SHA512:
-  metadata.gz: a57a8444a61350a4568af7cff50009a2798e3d0cd69798b133085e45ab179121f8c1b304a160d62300b2812fe80b04478ea55c01f310fe21de24a51ab5e2aa2a
-  data.tar.gz: 5e243df783f49669dce867aa303cb5e75009e751748a862a08862b67061fbff211eca00c4f1db3854c45f39ec7b08dd6ddff47f1062d2dedb64f38bb5f0e691d
+  metadata.gz: 7a16398319ebcc4c88f2c1622a7d12c45b0528ccc1bbfe8570894dcc34340e77288d74cb94631d1293a9920dee3b2980015503364b4359b341f8db086739e707
+  data.tar.gz: aadec96c432b3454d8a325c5476f3c87d8799611fa9416e84306a7cf634bda789e44c4590b1e023fdecece709c4ca70db81c740e9d379e7829341d9025b889bc

data/lib/authy/api.rb

@@ -1,4 +1,8 @@
+require 'logger'
+
 module Authy
+
+  AUTHY_LOGGER = Logger.new(STDOUT)
   #
   #  Authy.api_key = 'foo'
   #  Authy.api_uri = 'http://test-authy-api.heroku.com/'
@@ -14,16 +18,15 @@ module Authy
     include_http_client(agent_name: USER_AGENT)
 
     def self.register_user(attributes)
-      api_key = attributes.delete(:api_key)
+      api_key = attributes.delete(:api_key) || Authy.api_key
       send_install_link_via_sms = attributes.delete(:send_install_link_via_sms) { true }
       params = {
         :user => attributes,
-        :api_key => api_key || Authy.api_key,
         :send_install_link_via_sms => send_install_link_via_sms
       }
 
       url = "#{Authy.api_uri}/protected/json/users/new"
-      response = http_client.post(url, :body => escape_query(params))
+      response = http_client.post(url, :body => escape_query(params), :header => default_header(api_key: api_key))
 
       Authy::User.new(response)
     end
@@ -86,13 +89,15 @@ module Authy
     private
 
     def self.post_request(uri, params = {})
+      header_ = default_header(params: params)
+
       uri_params = keys_to_verify(uri, params)
       state, error = validate_for_url(uri_params, params)
 
       response = if state
                    url = "#{Authy.api_uri}/#{eval_uri(uri, params)}"
                    params = clean_uri_params(uri_params, params)
-                   http_client.post(url, :body => escape_query({:api_key => Authy.api_key}.merge(params)))
+                   http_client.post(url, :body => escape_query(params), header: header_)
                  else
                    build_error_response(error)
                  end
@@ -100,12 +105,14 @@ module Authy
     end
 
     def self.get_request(uri, params = {})
+      header_ = default_header(params: params)
+
       uri_params = keys_to_verify(uri, params)
       state, error = validate_for_url(uri_params, params)
       response = if state
                    url = "#{Authy.api_uri}/#{eval_uri(uri, params)}"
                    params = clean_uri_params(uri_params, params)
-                   http_client.get(url, {:api_key => Authy.api_key}.merge(params))
+                   http_client.get(url, params, header_)
                  else
                    build_error_response(error)
                  end
@@ -143,5 +150,21 @@ module Authy
       response = build_error_response('Token is invalid')
       return Authy::Response.new(response)
     end
+
+    def self.default_header(api_key: nil, params: {})
+      header = {
+        "X-Authy-API-Key" => api_key || Authy.api_key
+      }
+
+      api_key_ = params.delete(:api_key) || params.delete("api_key")
+
+      if api_key_ && api_key_.strip != ""
+        AUTHY_LOGGER.warn("[DEPRECATED]: The Authy API key should not be sent as a parameter. Please send the HTTP header 'X-Authy-API-Key' instead.")
+        header["X-Authy-API-Key"] = api_key_
+      end
+
+      return header
+    end
+
   end
 end

data/lib/authy/version.rb

@@ -1,3 +1,3 @@
 module Authy
-  VERSION = "2.7.0"
+  VERSION = "2.7.1"
 end

data/spec/authy/api_spec.rb

@@ -1,6 +1,18 @@
 require 'spec_helper'
 
 describe "Authy::API" do
+
+  describe "request headers" do
+
+    it "contains api key in header" do
+      url = "protected/json/foo/2"
+
+      HTTPClient.any_instance.should_receive(:request).twice.with( any_args, hash_including(:header=> { "X-Authy-API-Key" => Authy.api_key }) ) { double(:ok? => true, :body => "", :status => 200) }
+      response = Authy::API.get_request(url, {})
+      response = Authy::API.post_request(url, {})
+    end
+  end
+
   describe "Registering users" do
 
     it "should find or create a user" do
@@ -122,7 +134,7 @@ describe "Authy::API" do
       it "should request a #{title} token" do
         uri_param = kind == "phone_call" ? "call" : kind
         url = "#{Authy.api_uri}/protected/json/#{uri_param}/#{Authy::API.escape_for_url(@user.id)}"
-        HTTPClient.any_instance.should_receive(:request).with(:get, url, {:query=>{:api_key=> Authy.api_key}, :header=>nil, :follow_redirect=>nil}) { double(:ok? => true, :body => "", :status => 200) }
+        HTTPClient.any_instance.should_receive(:request).with(:get, url, {:query=>{}, :header=>{ "X-Authy-API-Key" => Authy.api_key }, :follow_redirect=>nil}) { double(:ok? => true, :body => "", :status => 200) }
         response = Authy::API.send("request_#{kind}", :id => @user.id)
         response.should be_ok
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authy
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.1
 platform: ruby
 authors:
 - Authy Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-15 00:00:00.000000000 Z
+date: 2016-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: authy
-rubygems_version: 2.4.6
+rubygems_version: 2.6.0
 signing_key: 
 specification_version: 4
 summary: Ruby library to access Authy services