notarize 1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Aaron Klaassen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+## Notarize
+
+For basic json web services that don't want just anyone to have access. Generates signature hashes for http requests.
+
+## Installation
+
+Add this to your Gemfile:
+
+    gem 'notarize'
+
+And run:
+
+    $ bundle
+
+Or install it with:
+
+    $ gem install notarize
+
+
+## Usage
+
+## As the client
+
+    include Notarize::Client
+
+Implement a #config method that returns a hash with :host, :public_key, and :private_key values for the service you're using. Then just call #send_request with the path and a parameter list.
+
+    def config
+      { host: "http://www.example-service.com/", public_key: "yourname", private_key: "secret" }
+    end
+
+    ...
+
+    send_request("/example/path/42/", { foo: "Foo", bar: "Bar" })
+
+Optionally you can also pass in an alternate HTTP verb for non-GET requests. Accepted values are :get (the default), :post, :put, and :delete.
+
+    send_request("/example/path/42/", { foo: "Foo", bar: "Bar" }, :post)
+
+send_request returns a hash with two values. :body with the parsed json response, and :code with the HTTP status code.
+
+## As the server
+
+Notarize provides a generate_signature helper method that takes a hash of the incoming params, and the private key of the client making the request. Result should match the value in the incoming 'signature' parameter. For example, in a before_filter:
+
+    include Notarize::Helper
+    
+    before_filter :authenticate_request!
+    ...
+
+    def authenticate_request!
+      client = ApiClient.where(public_key: params[:public_key]).first # Or however your app works.
+
+      if generate_signature(params, client.private_key) == params[:signature]
+        # It's ok!
+      else
+        # Get outta town!
+      end
+    end
+
+Notarize doesn't manage your list of authorized clients for you.
+
+## Parties Responsible
+
+Author: Aaron Klaassen (aaron@outerspacehero.com)

data/lib/notarize/version.rb

@@ -0,0 +1,3 @@
+module Notarize
+  VERSION = "1.0"
+end

data/lib/notarize.rb

@@ -0,0 +1,49 @@
+require "notarize/version"
+
+module Notarize
+
+  module Helper
+    protected
+
+    def sorted_query_string(params, reject_sig = true)
+      params = params.reject { |k, v| k.to_s == 'signature' } if reject_sig
+
+      qs = params.keys.sort_by { |k,v| k.to_s }.collect do |key|
+        "#{key}=#{params[key]}"
+      end.join('&')
+    end
+
+    def generate_signature(params, salt)
+      Digest::SHA256.hexdigest(sorted_query_string(params) + salt)
+    end
+  end
+
+  module Client
+    include Notarize::Helper  
+
+    protected
+
+    def signed_url(path, params)
+      "#{config[:host]}#{path}?#{sorted_query_string(params)}&signature=#{generate_signature(params, config[:private_key])}"
+    end
+
+    def send_request(path, params = {}, method = :get)
+      raise ArgumentError.new("Invalid HTTP verb #{method}") if ![:get, :post, :put, :delete].include?(method)
+
+      params ||= {}
+      params.merge!({ public_key: config[:public_key] })
+      response = HTTParty.send(method, signed_url(path, params))
+
+      { body: JSON.parse(response.body), code: response.code }
+    end
+
+    def config
+      raise NotImplementedError.new "Notarize#config not implemented."
+      # {
+      #   host:        "example.com"
+      #   public_key:  "username"
+      #   private_key: "secret"
+      # }
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: notarize
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Klaassen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: For basic web services that don't want just anyone to have access. Generates
+  signature hashes for http requests.
+email:
+- aaron@outerspacehero.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/notarize/version.rb
+- lib/notarize.rb
+- LICENSE
+- README.md
+homepage: http://www.github.com/aaronklaassen/notarize/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple library for generating signed http requests.
+test_files: []