autopen 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in autopen.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 J-P Teti
+
+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,39 @@
+# Autopen
+
+Autopen writes your (OAuth) signatures for you. That's all it does. Simple.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'autopen'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install autopen
+
+## Usage
+
+	require 'autopen'
+	signature = Autopen::Signature.new(HTTP METHOD, URL, POST_PARAMS, {:consumer_key => "YOUR CONSUMER KEY", :consumer_secret => "YOUR CONSUMER SECRET", :version => "1.0 (probably)", :timestamp => Time.now.to_i, :nonce => "YOUR NONCE HERE", :token => "YOUR TOKEN, IF YOU HAVE ONE. OTHERWISE DON'T INCLUDE THIS VALUE AT ALL.", :token_secret => "YOUR TOKEN SECRET, IF YOU HAVE ONE. OTHERWISE DON'T INCLUDE THIS VALUE AT ALL."})
+	request_signature = s.generate
+
+That's a little... generic, so let's try an example. To generate the signature the Twitter API example documented [here](https://dev.twitter.com/docs/auth/authorizing-request) and [here](https://dev.twitter.com/docs/auth/creating-signature), do this:
+
+	require 'autopen'
+	s = Autopen::Signature.new("post", "https://api.twitter.com/1/statuses/update.json?include_entities=true", {"status" => "Hello Ladies + Gentlemen, a signed OAuth request!"}, {:consumer_key => "xvz1evFS4wEEPTGEFPHBog", :consumer_secret => "kAcSOqF21Fu85e7zjz7ZN2U4ZRhfV3WpwPAoE3Z7kBw", :version => "1.0", :timestamp => 1318622958, :nonce => "kYjzVBB8Y0ZFabxSWbWovY3uYSQ2pTgmZeNu2VS4cg", :token => "370773112-GmHxMAgYyLbNEtIKZeRNFsMKPR9EyMZeS9weJAEb", :token_secret => "LswwdoUaIvS8ltyTt5jkRh4J50vUPVVHtR2YPi5kE"})
+	request_signature = s.generate # returns "tnnArxj06cWHq44gCs1OSKk%2FjLY%3D"
+
+There's two other methods on an `Autopen::Signature` that might be useful. One is `oauth_params`, which will return an alphabetized Hash of all the OAuth params. The other is `url`, which will return the url you entered along with the OAuth params.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/autopen.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/autopen/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["J-P Teti"]
+  gem.email         = ["roboteti@me.com"]
+  gem.description   = %q{Autopen writes your (OAuth) signatures for you. That's all it does. Simple.}
+  gem.summary       = %q{Give Autopen your request data and URL, and Autopen returns an OAuth signature. Write your requests however you like. Use Autopen to generate the signature.}
+  gem.homepage      = "https://github.com/roboteti/autopen"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "autopen"
+  gem.require_paths = ["lib"]
+  gem.version       = Autopen::VERSION
+end

data/lib/autopen/definitions.rb

@@ -0,0 +1,3 @@
+module Autopen
+  RESERVED_CHARACTERS = /[^a-zA-Z0-9\-\.\_\~]/
+end

data/lib/autopen/signature.rb

@@ -0,0 +1,102 @@
+module Autopen
+  class Signature
+    attr_reader :method, :url, :post_params, :consumer, :oauth_details
+    
+    def initialize(method, url, post_params, oauth_details)
+      @method = method
+      @url = url
+      @post_params = post_params
+      @oauth_details = oauth_details
+    end
+    
+    def sign(key, base_string)
+      digest = OpenSSL::Digest::Digest.new('sha1')
+      hmac = OpenSSL::HMAC.digest(digest, key, base_string)
+      Base64.encode64(hmac).chomp.gsub(/\n/, '')
+    end
+    
+    def escape(value)
+      # This code is stolen, er, borrowed from the oAuth gem
+      URI::escape(value.to_s, Autopen::RESERVED_CHARACTERS)
+    rescue ArgumentError
+      URI::escape(value.to_s.force_encoding(Encoding::UTF_8), Autopen::RESERVED_CHARACTERS)
+    end
+    
+    def generate_param_string
+      if @post_params.nil?
+        all_params = {}
+      else
+        all_params = @post_params
+      end
+      
+      uri_from_url = URI(@url)
+      unless uri_from_url.query.nil?
+        query_string_params = uri_from_url.query.split("&")
+        query_string_params.each do |param|
+          a = param.split("=")
+          all_params[a[0]] = a[1]
+        end
+      end
+      
+      all_params["oauth_consumer_key"] = @oauth_details[:consumer_key]
+      all_params["oauth_nonce"] = @oauth_details[:nonce]
+      all_params["oauth_signature_method"] = "HMAC-SHA1"
+      all_params["oauth_timestamp"] = @oauth_details[:timestamp]
+      all_params["oauth_version"] = @oauth_details[:version]
+      
+      unless @oauth_details[:token].nil?
+        all_params["oauth_token"] = @oauth_details[:token]
+      end
+      
+      all_params = Hash[all_params.sort]
+      new_params = []
+      all_params.each do |key, value|
+        new_params<<("#{escape(key)}=#{escape(value)}")
+      end
+      new_params.join("&")
+    end
+    
+    def base_string
+      uri_from_url = URI(@url)
+      url_string = uri_from_url.scheme + "://" + uri_from_url.host + uri_from_url.path
+      @method.upcase + "&" + escape(url_string) + "&" + escape(generate_param_string)
+    end
+    
+    def generate
+      if @oauth_details[:token_secret].nil?
+        signing_key = @oauth_details[:consumer_secret] + "&"
+      else
+        signing_key = @oauth_details[:consumer_secret] + "&" + @oauth_details[:token_secret]
+      end
+      escape(sign(signing_key, base_string))
+    end
+    
+    def oauth_params
+      keys = {
+        "oauth_consumer_key"      => @oauth_details[:consumer_key],
+        "oauth_version"           => @oauth_details[:version],
+        "oauth_timestamp"         => @oauth_details[:timestamp],
+        "oauth_signature_method"  => "HMAC-SHA1",
+        "oauth_nonce"             => @oauth_details[:nonce],
+        "oauth_signature"         => generate  
+      }
+      Hash[keys.sort]
+    end
+    
+    def url
+      get_params = oauth_params
+      uri_from_url = URI(@url)
+      if uri_from_url.query.nil?
+        base = @url + "?"
+      else
+        base = @url
+      end
+      params = []
+      get_params.each do |key, value|
+        params<<("#{key}=#{value}")
+      end
+      query_string = params.join("&")
+      base + query_string
+    end
+  end
+end

data/lib/autopen/version.rb

@@ -0,0 +1,3 @@
+module Autopen
+  VERSION = "0.0.1"
+end

data/lib/autopen.rb

@@ -0,0 +1,6 @@
+require "CGI"
+require "openssl"
+require "base64"
+require "autopen/version"
+require "autopen/definitions"
+require "autopen/signature"

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: autopen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- J-P Teti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-13 00:00:00.000000000 Z
+dependencies: []
+description: Autopen writes your (OAuth) signatures for you. That's all it does. Simple.
+email:
+- roboteti@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- autopen.gemspec
+- lib/autopen.rb
+- lib/autopen/definitions.rb
+- lib/autopen/signature.rb
+- lib/autopen/version.rb
+homepage: https://github.com/roboteti/autopen
+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: Give Autopen your request data and URL, and Autopen returns an OAuth signature.
+  Write your requests however you like. Use Autopen to generate the signature.
+test_files: []