appoxy_api 0.0.7 → 0.0.8

data/lib/api/client.rb

@@ -1,82 +1,90 @@
 module Appoxy
-    module Api
+  module Api
 
-        require 'rest_client'
+    require 'rest_client'
 
-        # Subclass must define:
-        #  host: endpoint url for service
-        class Client
+    # Subclass must define:
+    #  host: endpoint url for service
+    class Client
 
-            attr_accessor :host, :access_key, :secret_key
+      @@logger = Logger.new(STDOUT)
+      @@logger.level = Logger::INFO
 
+      def self.logger
+        @@logger
+      end
 
-            def initialize(host, access_key, secret_key, options={})
-                @host = host
-                @access_key = access_key
-                @secret_key = secret_key
-            end
+      attr_accessor :host, :access_key, :secret_key
 
 
-            def get(method, params={}, options={})
-                begin
+      def initialize(host, access_key, secret_key, options={})
+        @host = host
+        @access_key = access_key
+        @secret_key = secret_key
+      end
+
+
+      def get(method, params={}, options={})
+        begin
 #                ClientHelper.run_http(host, access_key, secret_key, :get, method, nil, params)
-                    parse_response RestClient.get(append_params(url(method), add_params(method, params)), headers)
-                rescue RestClient::BadRequest => ex
+          parse_response RestClient.get(append_params(url(method), add_params(method, params)), headers), options
+        rescue RestClient::BadRequest => ex
 #                    puts ex.http_body
-                    raise "Bad Request: " + ActiveSupport::JSON.decode(ex.http_body)["msg"].to_s
-                end
-            end
+          raise "Bad Request: " + ActiveSupport::JSON.decode(ex.http_body)["msg"].to_s
+        end
+
+      end
 
 
-            def post(method, params={}, options={})
-                begin
-                    parse_response RestClient.post(url(method), add_params(method, params).to_json, headers)
-                    #ClientHelper.run_http(host, access_key, secret_key, :post, method, nil, params)
-                rescue RestClient::BadRequest => ex
+      def post(method, params={}, options={})
+        begin
+          parse_response RestClient.post(url(method), add_params(method, params).to_json, headers), options
+          #ClientHelper.run_http(host, access_key, secret_key, :post, method, nil, params)
+        rescue RestClient::BadRequest => ex
 #                    puts ex.http_body
-                    raise "Bad Request: " + ActiveSupport::JSON.decode(ex.http_body)["msg"].to_s
-                end
+          raise "Bad Request: " + ActiveSupport::JSON.decode(ex.http_body)["msg"].to_s
+        end
 
-            end
+      end
 
 
-            def put(method, body, options={})
-                begin
-                    parse_response RestClient.put(url(method), add_params(method, body).to_json, headers)
-                    #ClientHelper.run_http(host, access_key, secret_key, :put, method, body, nil)
-                rescue RestClient::BadRequest => ex
+      def put(method, body, options={})
+        begin
+          parse_response RestClient.put(url(method), add_params(method, body).to_json, headers), options
+          #ClientHelper.run_http(host, access_key, secret_key, :put, method, body, nil)
+        rescue RestClient::BadRequest => ex
 #                    puts ex.http_body
-                    raise "Bad Request: " + ActiveSupport::JSON.decode(ex.http_body)["msg"].to_s
-                end
-            end
+          raise "Bad Request: " + ActiveSupport::JSON.decode(ex.http_body)["msg"].to_s
+        end
+      end
 
 
-            def delete(method, params={}, options={})
-                begin
-                    parse_response RestClient.delete(append_params(url(method), add_params(method, params)))
-                rescue RestClient::BadRequest => ex
-                    raise "Bad Request: " + ActiveSupport::JSON.decode(ex.http_body)["msg"].to_s
-                end
-            end
+      def delete(method, params={}, options={})
+        begin
+          parse_response RestClient.delete(append_params(url(method), add_params(method, params))), options
+        rescue RestClient::BadRequest => ex
+          raise "Bad Request: " + ActiveSupport::JSON.decode(ex.http_body)["msg"].to_s
+        end
+      end
 
 
-            def url(command_path)
-                url = host + command_path
-                url
-            end
+      def url(command_path)
+        url = host + command_path
+        url
+      end
 
-            # old way
- def add_params(command_path, hash)
-                ts = Appoxy::Api::Signatures.generate_timestamp(Time.now.gmtime)
-                # puts 'timestamp = ' + ts
-                sig = Appoxy::Api::Signatures.generate_signature(command_path, ts, secret_key)
+      # old way
+      def add_params(command_path, hash)
+        ts = Appoxy::Api::Signatures.generate_timestamp(Time.now.gmtime)
+        # puts 'timestamp = ' + ts
+        sig = Appoxy::Api::Signatures.generate_signature(command_path, ts, secret_key)
 
-                extra_params = {'sigv'=>"0.1", 'sig' => sig, 'timestamp' => ts, 'access_key' => access_key}
-                hash.merge!(extra_params)
+        extra_params = {'sigv'=>"0.1", 'sig' => sig, 'timestamp' => ts, 'access_key' => access_key}
+        hash.merge!(extra_params)
 
- end
+      end
 
-            # new way
+      # new way
 #            def add_params(command_path, hash)
 #                ts = Appoxy::Api::Signatures.generate_timestamp(Time.now.gmtime)
 #                #p "hash_to s" + command_path + Appoxy::Api::Signatures.hash_to_s(hash)
@@ -87,35 +95,39 @@ module Appoxy
 #            end
 
 
-            def append_params(host, params)
-                host += "?"
-                i = 0
-                params.each_pair do |k, v|
-                    host += "&" if i > 0
-                    host += k + "=" + CGI.escape(v)
-                    i+=1
-                end
-                return host
-            end
-
-
-            def headers
-                user_agent = "Appoxy API Ruby Client"
-                headers = {'User-Agent' => user_agent}
-            end
-
-
-            def parse_response(response)
-                begin
-                    return ActiveSupport::JSON.decode(response.to_s)
-                rescue => ex
-                    puts 'response that caused error = ' + response.to_s
-                    raise ex
-                end
-            end
-
-
+      def append_params(host, params)
+        host += "?"
+        i = 0
+        params.each_pair do |k, v|
+          host += "&" if i > 0
+          host += k + "=" + CGI.escape(v)
+          i +=1
+        end
+        return host
+      end
+
+
+      def headers
+        user_agent = "Appoxy API Ruby Client"
+        headers = {'User-Agent' => user_agent}
+      end
+
+
+      def parse_response(response, options={})
+        unless options[:parse] == false
+          begin
+            return ActiveSupport::JSON.decode(response.to_s)
+          rescue => ex
+            puts 'response that caused error = ' + response.to_s
+            raise ex
+          end
+        else
+          response
         end
+      end
+
 
     end
+
+  end
 end

data/lib/api/client_helper.rb

@@ -1,32 +1,32 @@
 module Appoxy
-    module Api
+  module Api
 
-        require 'rest_client'
+    require 'rest_client'
 
-        module ClientHelper
+    module ClientHelper
 
 
-        end
+    end
 
-        class ClientError < StandardError
+    class ClientError < StandardError
 
-            attr_reader :response_hash
+      attr_reader :response_hash
 
-            def initialize(class_name, response_hash)
-                puts 'response-hash=' + response_hash.inspect
-                super("#{class_name} - #{response_hash["msg"]}")
-                @response_hash = response_hash
-            end
-        end
+      def initialize(class_name, response_hash)
+        puts 'response-hash=' + response_hash.inspect
+        super("#{class_name} - #{response_hash["msg"]}")
+        @response_hash = response_hash
+      end
+    end
 
-        class ServiceError < StandardError
-            attr_reader :body
+    class ServiceError < StandardError
+      attr_reader :body
 
-            def initialize(class_name, body)
-                super("#{class_name}")
-                @body = body
+      def initialize(class_name, body)
+        super("#{class_name}")
+        @body = body
 
-            end
-        end
+      end
     end
+  end
 end

data/lib/api/signatures.rb

@@ -1,26 +1,26 @@
 module Appoxy
-    module Api
-        module Signatures
+  module Api
+    module Signatures
 
 
-            def self.generate_timestamp(gmtime)
-                return gmtime.strftime("%Y-%m-%dT%H:%M:%SZ")
-            end
+      def self.generate_timestamp(gmtime)
+        return gmtime.strftime("%Y-%m-%dT%H:%M:%SZ")
+      end
 
 
-            def self.generate_signature(operation, timestamp, secret_key)
-                my_sha_hmac = Digest::HMAC.digest(operation + timestamp, secret_key, Digest::SHA1)
-                my_b64_hmac_digest = Base64.encode64(my_sha_hmac).strip
-                return my_b64_hmac_digest
-            end
+      def self.generate_signature(operation, timestamp, secret_key)
+        my_sha_hmac        = Digest::HMAC.digest(operation + timestamp, secret_key, Digest::SHA1)
+        my_b64_hmac_digest = Base64.encode64(my_sha_hmac).strip
+        return my_b64_hmac_digest
+      end
 
 
-            def self.hash_to_s(hash)
-                str = ""
-                hash.each_pair {|key, value| str+= "#{key}#{value}" }
-                #removing all characters that could differ after parsing with rails
-                return str.delete "\"\/:{}[]\' T"
-            end
-        end
+      def self.hash_to_s(hash)
+        str = ""
+        hash.each_pair { |key, value| str+= "#{key}#{value}" }
+        #removing all characters that could differ after parsing with rails
+        return str.delete "\"\/:{}[]\' T"
+      end
     end
+  end
 end

data/lib/appoxy_api.rb

@@ -1,9 +1,8 @@
-require 'active_support'
+require 'active_support/core_ext'
 require 'digest/hmac'
 require 'net/http'
 require 'base64'
-  
-require File.join(File.dirname(__FILE__), "api", "api_controller")
+
 require File.join(File.dirname(__FILE__), "api", "client_helper")
 require File.join(File.dirname(__FILE__), "api", "signatures")
 require File.join(File.dirname(__FILE__), "api", "client")

metadata

@@ -1,45 +1,35 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: appoxy_api
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Travis Reeder
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-29 00:00:00 -08:00
+date: 2011-02-21 00:00:00.000000000 -08:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rest-client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &26585748 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *26585748
 description: Appoxy API Helper gem description...
 email: travis@appoxy.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
-- lib/api/api_controller.rb
+files:
 - lib/api/client.rb
 - lib/api/client_helper.rb
 - lib/api/signatures.rb
@@ -48,34 +38,26 @@ files:
 has_rdoc: true
 homepage: http://www.appoxy.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Appoxy API Helper gem
 test_files: []
-

data/lib/api/api_controller.rb

@@ -1,113 +0,0 @@
-module Appoxy
-
-    module Api
-
-        # The api controllers that use this should set:
-#        protect_from_forgery :only => [] # can add methods to here, eg: :create, :update, :destroy
-
-#                rescue_from SigError, :with => :send_error
-#                rescue_from Api::ApiError, :with => :send_error
-        # before_filter :verify_signature(params)
-
-        # Your Controller must define a secret_key_for_signature method which will return the secret key to use to generate signature.
-
-        module ApiController
-
-            def verify_signature
-                params2 = nil
-                if request.put? || request.post?
-                    # We'll extract params from body instead here
-                    # todo: maybe check for json format first in case this is a file or something?
-                    body = request.body.read
-                    puts 'body=' + body.inspect
-                    params2 = ActiveSupport::JSON.decode(body)
-                    puts 'params2=' + params2.inspect
-                    params.merge! params2
-                end
-
-                #operation = "#{controller_name}/#{action_name}"
-                #operation = request.env["PATH_INFO"].gsub(/\/api\//, "")# here we're getting original request url'
-
-#                #getting clean params (without parsed via routes)
-#                params_for_signature = params2||request.query_parameters
-#                #removing mandatory params
-#                params_for_signature = params_for_signature.delete_if {|key, value| ["access_key", "sigv", "sig", "timestamp"].include? key}
-
-
-                #puts "params " +operation+Appoxy::Api::Signatures.hash_to_s(params_for_signature)
-                access_key = params["access_key"]
-                sigv = params["sigv"]
-                timestamp = params["timestamp"]
-                sig = params["sig"]
-                signature = ""
-                case sigv
-                    when "0.1"
-                        puts "outdated version of client"
-                        signature = "#{controller_name}/#{action_name}"
-                    when "0.2"
-                        puts "new version of client"
-                        operation = request.env["PATH_INFO"].gsub(/\/api\//, "")# here we're getting original request url'
-                        params_for_signature = params2||request.query_parameters
-                        params_for_signature = params_for_signature.delete_if {|key, value| ["access_key", "sigv", "sig", "timestamp"].include? key}
-                        signature = operation+Appoxy::Api::Signatures.hash_to_s(params_for_signature)
-                end
-#                puts "signature " + signature
-                raise Appoxy::Api::ApiError, "No access_key" if access_key.nil?
-                raise Appoxy::Api::ApiError, "No sigv" if sigv.nil?
-                raise Appoxy::Api::ApiError, "No timestamp" if timestamp.nil?
-                raise Appoxy::Api::ApiError, "No sig" if sig.nil?
-                timestamp2 = Appoxy::Api::Signatures.generate_timestamp(Time.now.gmtime)
-                raise Appoxy::Api::ApiError, "Request timed out!" unless (Time.parse(timestamp2)-Time.parse(timestamp))<60 # deny all requests older than 60 seconds
-                sig2 = Appoxy::Api::Signatures.generate_signature(signature, timestamp, secret_key_for_signature(access_key))
-                raise Appoxy::Api::ApiError, "Invalid signature!" unless sig == sig2
-
-                puts 'Signature OK'
-
-            end
-
-
-            def sig_should
-                raise "You didn't define a sig_should method in your controller!"
-            end
-
-
-            def send_ok(msg={})
-                response_as_string = '' # in case we want to add debugging or something
-#                respond_to do |format|
-                #                format.json { render :json=>msg }
-#                response_as_string = render_to_string :json => msg
-                render :json => msg
-#                end
-                true
-            end
-
-
-            def send_error(statuscode_or_error, msg=nil)
-                exc = nil
-                if statuscode_or_error.is_a? Exception
-                    exc = statuscode_or_error
-                    statuscode_or_error = 400
-                    msg = exc.message
-                end
-                # deprecate status, should use status_code
-                json_msg = {"status_code"=>statuscode_or_error, "msg"=>msg}
-                render :json=>json_msg, :status=>statuscode_or_error
-                true
-            end
-
-
-        end
-
-
-        class ApiError < StandardError
-
-            def initialize(msg=nil)
-                super(msg)
-
-            end
-
-        end
-
-    end
-
-end