authy 2.1.0 → 2.2.0

data/README.md

@@ -1,4 +1,4 @@
-# Authy [![Build Status](https://travis-ci.org/authy/authy-ruby.png?branch=api-updates)](https://travis-ci.org/authy/authy-ruby) [![Code Climate](https://codeclimate.com/github/authy/authy-ruby.png)](https://codeclimate.com/github/authy/authy-ruby)
+# Authy [![Build Status](https://travis-ci.org/authy/authy-ruby.png?branch=master)](https://travis-ci.org/authy/authy-ruby) [![Code Climate](https://codeclimate.com/github/authy/authy-ruby.png)](https://codeclimate.com/github/authy/authy-ruby)
 
 Ruby library to access the Authy API
 

data/VERSION

@@ -1 +1 @@
-2.1.0
+2.2.0

data/authy.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "authy"
-  s.version = "2.1.0"
+  s.version = "2.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Authy", "David A. Cuadrado"]
-  s.date = "2013-06-03"
+  s.date = "2013-06-17"
   s.description = "Ruby library to access Authy services"
   s.email = "krawek@gmail.com"
   s.executables = ["authy-api-console"]
@@ -35,8 +35,10 @@ Gem::Specification.new do |s|
     "lib/authy/core_ext.rb",
     "lib/authy/models/user.rb",
     "lib/authy/response.rb",
+    "lib/authy/url_helpers.rb",
     "spec/authy/api_spec.rb",
     "spec/authy/response_spec.rb",
+    "spec/authy/url_helpers_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/authy/authy"

data/lib/authy.rb

@@ -4,6 +4,7 @@ require 'httpclient'
 require 'httpclient/include_client'
 require 'json'
 
+require 'authy/url_helpers'
 require 'authy/core_ext'
 require 'authy/response'
 require 'authy/models/user'

data/lib/authy/api.rb

@@ -6,9 +6,12 @@ module Authy
   class API
     USER_AGENT = "authy-ruby"
 
+    include Authy::URL
+
     extend HTTPClient::IncludeClient
     include_http_client
 
+
     def self.register_user(attributes)
       api_key = attributes.delete(:api_key)
       params = {
@@ -32,10 +35,9 @@ module Authy
       user_id = params.delete(:id) || params.delete('id')
       params[:force] = true if params[:force].nil? && params['force'].nil?
 
-      url = "#{Authy.api_uri}/protected/json/verify/#{escape_for_url(token)}/#{escape_for_url(user_id)}"
-      response = http_client.get(url, {:api_key => Authy.api_key}.merge(params))
-
-      Authy::Response.new(response)
+      get_request("protected/json/verify/:token/:user_id", params.merge({
+                                                                          "token" => token,
+                                                                          "user_id" => user_id}))
     end
 
     # options:
@@ -44,10 +46,7 @@ module Authy
     def self.request_sms(params)
       user_id = params.delete(:id) || params.delete('id')
 
-      url = "#{Authy.api_uri}/protected/json/sms/#{escape_for_url(user_id)}"
-      response = http_client.get(url, {:api_key => Authy.api_key}.merge(params))
-
-      Authy::Response.new(response)
+      get_request("protected/json/sms/:user_id", params.merge({"user_id" => user_id}))
     end
 
     # options:
@@ -56,10 +55,7 @@ module Authy
     def self.request_phone_call(params)
       user_id = params.delete(:id) || params.delete('id')
 
-      url = "#{Authy.api_uri}/protected/json/call/#{escape_for_url(user_id)}"
-      response = http_client.get(url, {:api_key => Authy.api_key}.merge(params))
-
-      Authy::Response.new(response)
+      get_request("protected/json/call/:user_id", params.merge({"user_id" => user_id}))
     end
 
     # options:
@@ -67,44 +63,51 @@ module Authy
     def self.delete_user(params)
       user_id = params.delete(:id) || params.delete('id')
 
-      url = "#{Authy.api_uri}/protected/json/users/delete/#{escape_for_url(user_id)}"
-      response = http_client.post(url, {:api_key => Authy.api_key}.merge(params))
+      post_request("protected/json/users/delete/:user_id", params.merge({"user_id" =>user_id}))
+    end
+
+    private
 
+    def self.post_request(uri, 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)))
+                 else
+                   build_error_response(error)
+                 end
       Authy::Response.new(response)
     end
 
-    private
-    def self.escape_for_url(field)
-      URI.escape(field.to_s.strip, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    def self.get_request(uri, 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))
+                 else
+                   build_error_response(error)
+                 end
+      Authy::Response.new(response)
     end
 
-    # Copied and extended from httpclient's HTTP::Message#escape_query()
-    def self.escape_query(query, namespace = nil) # :nodoc:
-      pairs = []
-      query.each { |attr, value|
-        left = namespace ? "#{namespace}[#{attr.to_s}]" : attr.to_s
-        if values = Array.try_convert(value)
-          values.each { |value|
-            if value.respond_to?(:read)
-              value = value.read
-            end
-
-            if value.kind_of?(Hash)
-              pairs.push(escape_query(value, left+"[]"))
-            else
-              pairs.push(HTTP::Message.escape(left+ '[]') << '=' << HTTP::Message.escape(value.to_s))
-            end
-          }
-        elsif values = Hash.try_convert(value)
-          pairs.push(escape_query(values, left.dup))
-        else
-          if value.respond_to?(:read)
-            value = value.read
-          end
-          pairs.push(HTTP::Message.escape(left) << '=' << HTTP::Message.escape(value.to_s))
-        end
-      }
-      pairs.join('&')
+    def self.build_error_response(error = "blank uri param found")
+      OpenStruct.new(
+                     {
+                       'status'  => 400,
+                       'body' =>
+                       {
+                         'success' => false,
+                         'message' => error,
+                         'errors' => {
+                           'message' => error
+                         }
+                       }.to_json
+                     })
     end
   end
 end

data/lib/authy/url_helpers.rb

@@ -0,0 +1,74 @@
+module Authy
+  module URL
+    def self.included receiver
+      receiver.extend ClassMethods
+    end
+
+    module ClassMethods
+      def keys_to_verify(uri, params)
+        uri.scan(/:(\w+)/).flatten
+      end
+
+      def clean_uri_params(uri_params, params)
+        params.reject { |k, v| uri_params.include? k}
+      end
+
+      def eval_uri(uri, params = {})
+        uri.gsub(/:\w+/) {|s| params[s.gsub(":", "")]}
+      end
+
+      def validate_for_url(names, to_validate = {})
+        names.each do |name|
+          value = to_validate[name]
+          if value.nil? or value.to_s.empty? or value.to_s.split(" ").size == 0
+            puts "#{name} param is blank."
+            return [ false, "#{name} is blank." ]
+          end
+        end
+        [ true, ""]
+      end
+      
+      def escape_for_url(field)
+        URI.escape(field.to_s.strip, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      end
+
+      def to_param(left, right)
+        HTTP::Message.escape(left) + '=' +  HTTP::Message.escape(right.to_s)
+      end
+
+      def params_from_array(left, values)
+        values.map do |value|
+          if value.respond_to?(:read)
+            value = value.read
+          end
+
+          if value.kind_of?(Hash)
+            escape_query(value, left+"[]")
+          else
+            to_param(left + '[]', value)
+          end
+        end
+      end
+
+      # Copied and extended from httpclient's HTTP::Message#escape_query()
+      def escape_query(query, namespace = nil) # :nodoc:
+        pairs = []
+
+        query.each do |attr, value|
+          left = namespace ? "#{namespace}[#{attr.to_s}]" : attr.to_s
+          if values = Array.try_convert(value)
+            pairs += params_from_array(left, values)
+          elsif values = Hash.try_convert(value)
+            pairs.push(escape_query(values, left.dup))
+          else
+            if value.respond_to?(:read)
+              value = value.read
+            end
+            pairs.push(to_param(left, value))
+          end
+        end
+        pairs.join('&')
+      end
+    end
+  end
+end

data/spec/authy/api_spec.rb

@@ -33,6 +33,7 @@ describe "Authy::API" do
       user.should_not be_ok
       user.errors['message'].should =~ /invalid api key/i
     end
+
   end
 
   describe "verificating tokens" do
@@ -114,4 +115,25 @@ describe "Authy::API" do
       end
     end
   end
+
+  describe "blank params" do
+    before do
+      @user = Authy::API.register_user(:email => generate_email, :cellphone => generate_cellphone, :country_code => 1)
+      @user.should be_ok
+    end
+
+    [:request_sms, :request_phone_call, :delete_user].each do |method|
+      it "should return a proper response with the errors for #{method}" do
+        response = Authy::API.send(method, :id => nil)
+        response.should_not be_ok
+        response.message.should == "user_id is blank."
+      end
+    end
+
+    it "should return a prope response with the errors for verify" do
+      response = Authy::API.verify({})
+      response.should_not be_ok
+      response.message.should == "token is blank."
+    end
+  end
 end

data/spec/authy/url_helpers_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe "Authy::URL" do
+  class Dummy
+    include Authy::URL
+  end
+
+  describe "escape_for_url" do
+    it "should user URI escape" do
+      URI.should_receive :escape
+      Dummy.escape_for_url("that")
+    end
+
+    it "should use Regexp" do
+      Regexp.should_receive(:new).with("[^#{URI::PATTERN::UNRESERVED}]").and_return(/a/)
+      Dummy.escape_for_url("that")
+    end
+  end
+
+  describe "to_param" do
+    it "should user HTTP::Message.escape" do
+      HTTP::Message.should_receive(:escape).exactly(2).times.and_return "basic string"
+      Dummy.to_param('key', 'value')
+    end
+
+    it "should paramify the left to right" do
+      Dummy.to_param('key', 'value').should == 'key=value'
+    end
+  end
+
+  describe "params_from_array" do
+    it "should return an array of params" do
+      Dummy.params_from_array("da key", ["one", "two"]).should == [HTTP::Message.escape("da key[]") + "=one", HTTP::Message.escape("da key[]") + "=two"]
+    end
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: authy
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Authy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-03 00:00:00.000000000 Z
+date: 2013-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   version_requirements: !ruby/object:Gem::Requirement
@@ -166,8 +166,10 @@ files:
 - lib/authy/core_ext.rb
 - lib/authy/models/user.rb
 - lib/authy/response.rb
+- lib/authy/url_helpers.rb
 - spec/authy/api_spec.rb
 - spec/authy/response_spec.rb
+- spec/authy/url_helpers_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/authy/authy
 licenses:
@@ -183,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: 1227098339926430603
+      hash: -1090702034643817061
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false