appoxy_api 0.0.1

data/README.markdown

@@ -0,0 +1 @@
+Nada.

data/lib/api/api_controller.rb

@@ -0,0 +1,80 @@
+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 sig_should method which will return the signature to compare against.
+
+        module ApiController
+
+            def verify_signature(params, operation)
+
+#            puts 'params in base=' + params.inspect
+
+                access_key = params["access_key"]
+                sigv = params["sigv"]
+                timestamp = params["timestamp"]
+                sig = params["sig"]
+
+                raise Api::SigError, "No access_key" if access_key.nil?
+                raise Api::SigError, "No sigv" if sigv.nil?
+                raise Api::SigError, "No timestamp" if timestamp.nil?
+                raise Api::SigError, "No sig" if sig.nil?
+
+                # todo: verify sig!  Use SimpleWorker::HttpEnabled signature methods
+                sig2 = Appoxy::Api::Signatures.generate_signature(operation, timestamp, @project.secret_key)
+
+                raise Api::ApiError, "Invalid signature!" unless sig_should == sig2
+
+            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 => response_as_string
+                end
+                true
+            end
+
+
+            def send_error(statuscode_or_error, msg)
+                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

data/lib/api/client.rb

@@ -0,0 +1,41 @@
+module Appoxy
+    module Api
+
+        # Subclass must define:
+        #  host: endpoint url for service
+        class Client
+
+            attr_accessor :access_key, :secret_key
+
+            def initialize(host, access_key, secret_key, options={})
+                @access_key = access_key
+                @secret_key = secret_key
+
+            end
+
+            def get(method, params={}, options={})
+                parse_response ClientHelper.run_http(host, access_key, secret_key, :get, method, nil, params)
+            end
+
+            def post(method, params={}, options={})
+               parse_response ClientHelper.run_http(host, access_key, secret_key, :post, method, nil, params)
+            end
+
+            def put(method, body, options={})
+                parse_response ClientHelper.run_http(host, access_key, secret_key, :put, method, body, nil)
+            end
+
+            def parse_response(response)
+                begin
+                    return ActiveSupport::JSON.decode(response)
+                rescue => ex
+                    puts 'response that caused error = ' + response.to_s
+                    raise ex
+                end
+            end
+
+
+        end
+        
+    end
+end

data/lib/api/client_helper.rb

@@ -0,0 +1,109 @@
+module Appoxy
+    module Api
+        module ClientHelper
+
+            # TODO: SWAP OUT ALL THIS CRAP AND USE REST-CLIENT INSTEAD
+
+            # body is a hash
+            def self.run_http(host, access_key, secret_key, http_method, command_path, body=nil, parameters={}, extra_headers=nil)
+                ts = Appoxy::Api::Signatures.generate_timestamp(Time.now.gmtime)
+                # puts 'timestamp = ' + ts
+                sig = Appoxy::Api::Signatures.generate_signature(command_path, ts, secret_key)
+                # puts "My signature = " + sig
+                url = host + command_path
+                # puts url
+
+                user_agent = "Ruby Client"
+                headers = {'User-Agent' => user_agent}
+
+                if !extra_headers.nil?
+                    extra_headers.each_pair do |k, v|
+                        headers[k] = v
+                    end
+                end
+
+                extra_params = {'sigv'=>"0.1", 'sig' => sig, 'timestamp' => ts, 'access_key' => access_key}
+                if http_method == :put
+                    body.update(extra_params)
+                else
+                    parameters = {} if parameters.nil?
+                    parameters.update(extra_params)
+#                puts 'params=' + parameters.inspect
+
+                end
+
+
+                uri = URI.parse(url)
+                #puts 'body=' + body.to_s
+                if (http_method == :put)
+                    req = Net::HTTP::Put.new(uri.path)
+                    body = ActiveSupport::JSON.encode(body)
+                    req.body = body unless body.nil?
+                elsif (http_method == :post)
+                    req = Net::HTTP::Post.new(uri.path)
+                    if !parameters.nil?
+                        req.set_form_data(parameters)
+                    else
+                        req.body = body unless body.nil?
+                    end
+                elsif (http_method == :delete)
+                    req = Net::HTTP::Delete.new(uri.path)
+                    if !parameters.nil?
+                        req.set_form_data(parameters)
+                    end
+                else
+                    req = Net::HTTP::Get.new(uri.path)
+                    if !parameters.nil?
+                        req.set_form_data(parameters)
+                    end
+                end
+                headers.each_pair do |k, v|
+                    req[k] = v
+                end
+                # req.each_header do |k, v|
+                # puts 'header ' + k + '=' + v
+                #end
+                res = Net::HTTP.start(uri.host, uri.port) do |http|
+                    http.request(req)
+                end
+
+                ret = ''
+                case res
+                    when Net::HTTPSuccess
+                        # puts 'response body=' + res.body
+                        ret = res.body
+                    when Net::HTTPClientError
+                        raise ClientError.new(res.class.name, ActiveSupport::JSON.decode(res.body))
+                    else
+                        #res.error
+                        raise ServiceError.new(res.class.name, res.body)
+                end
+                return ret
+
+            end
+
+        end
+
+        class ClientError < StandardError
+
+            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
+
+        class ServiceError < StandardError
+            attr_reader :body
+
+            def initialize(class_name, body)
+                super("#{class_name}")
+                @body = body
+
+            end
+        end
+    end
+end
+	

data/lib/api/signatures.rb

@@ -0,0 +1,22 @@
+module Appoxy
+    module Api
+        module Signatures
+
+
+            def self.generate_timestamp(gmtime)
+                return gmtime.strftime("%Y-%m-%dT%H:%M:%SZ")
+            end
+
+            def self.generate_signature(operation, timestamp, secret_key)
+#                if USE_EMBEDDED_HMAC
+#                    my_sha_hmac = HMAC::SHA1.digest(secret_key, operation + timestamp)
+#                else
+                my_sha_hmac = Digest::HMAC.digest(operation + timestamp, secret_key, Digest::SHA1)
+#                end
+                my_b64_hmac_digest = Base64.encode64(my_sha_hmac).strip
+                return my_b64_hmac_digest
+            end
+
+        end
+    end
+end

data/lib/appoxy_api.rb

@@ -0,0 +1,5 @@
+
+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")
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: appoxy_api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Travis Reeder
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-21 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Appoxy API Helper gem description...
+email: travis@appoxy.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- lib/api/api_controller.rb
+- lib/api/client.rb
+- lib/api/client_helper.rb
+- lib/api/signatures.rb
+- lib/appoxy_api.rb
+- README.markdown
+has_rdoc: true
+homepage: http://www.appoxy.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Appoxy API Helper gem
+test_files: []
+