twitter-request-headers 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7eb6fec8fecbd186132ee9ead43797f2b47c525d
+  data.tar.gz: 642a343866131b6bffd11e3c0fab3f8f98f339e0
+SHA512:
+  metadata.gz: 34535137f9df376819d1c3f6908b20c45254b68bc40e69f839db21067b71ac5a6f93f018f9277edcf165389f150bf6360bef0b172e1ee5fd0e52cbc26eb882a6
+  data.tar.gz: 0bcf733afc3a6bb3a6c56cc6743985c49e95d83a6cfca4dfe102581967a6495435099afb70fa812840a14a1e96ada6b873f88f9e06b9e195295c524c72b0756b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dmitriy K.
+
+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,40 @@
+# TwitterRequestHeaders
+
+This gem is intended to easily format Twitter API's `Authorization` HTTP header.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twitter-request-headers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twitter-request-headers
+
+## Usage
+
+```ruby
+TwitterRequestHeaders.configure(
+  'KWZqnnFc8PPMjHOmXUpYNAMlI', # App ID
+  '7HqOlwq7petgYbZwYIznWvaW6gxykFEoiWTliNMCNKosut5VXS' # App Secret
+)
+
+TwitterRequestHeaders.new(
+  '150425432-3dAJqsCUXstN1kKgMwpFQGy9JtW6KgBeD30C1b4R', # OAuth Token
+  'YHwc8jkR2pKAISscibQdymNKaXR8dzDsAabQknaJdYs9l', # OAuth Secret
+  'GET',
+  '/users/show.json',
+  {'user_id' => '110425482'}
+).header
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twitter_request_headers"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/escape_uri_string.rb

@@ -0,0 +1,45 @@
+=begin
+  Twitter requires specific request encoding. More details at this link:
+  https://dev.twitter.com/oauth/overview/percent-encoding-parameters
+=end
+
+require 'uri'
+
+class EscapeUriString
+  RESERVED_CHARACTERS = /[^a-zA-Z0-9\-\.\_\~]/
+
+  def initialize(string)
+    @string = string
+    validate
+  end
+
+  def escape
+    escaped = escape_uri(@string) || escape_uri(@string.force_encoding(Encoding::UTF_8))
+
+    unless escaped
+      fail ArgumentError, "Unable to escape string: #{@string}"
+    end
+
+    escaped
+  end
+
+  private
+
+  def validate
+    unless @string.kind_of?(String)
+      fail ArgumentError, 'Attempt to escape non-string'
+    end
+
+    if @string.nil? || @string.empty?
+      fail ArgumentError, 'Attempt to escape empty string'
+    end
+  end
+
+  def escape_uri(string)
+    begin
+      URI::escape(string, RESERVED_CHARACTERS)
+    rescue ArgumentError
+    rescue
+    end
+  end
+end

data/lib/header.rb

@@ -0,0 +1,34 @@
+class Header
+  require 'twitter_request_headers'
+  require 'escape_uri_string'
+
+  def self.key
+    'Authorization'
+  end
+
+  def initialize(oauth_token, signature, nonce, epochtime)
+    @oauth_token = oauth_token
+    @signature = signature
+
+    @nonce = nonce
+    @epochtime = epochtime
+  end
+
+  def value
+    <<-EOF
+    OAuth #{escape('oauth_consumer_key')}="#{escape(TwitterRequestHeaders.consumer_key)}",
+          #{escape('oauth_nonce')}="#{escape(@nonce)}",
+          #{escape('oauth_signature')}="#{escape(@signature)}",
+          #{escape('oauth_signature_method')}="#{escape(TwitterRequestHeaders.oauth_cipher)}",
+          #{escape('oauth_timestamp')}="#{escape(@epochtime)}",
+          #{escape('oauth_token')}="#{escape(@oauth_token)}",
+          #{escape('oauth_version')}="#{escape(TwitterRequestHeaders.oauth_version)}"
+    EOF
+  end
+
+  private
+
+  def escape(string)
+    EscapeUriString.new(string).escape
+  end
+end

data/lib/signature.rb

@@ -0,0 +1,40 @@
+class Signature
+  require 'securerandom'
+  require 'base64'
+
+  require 'signing_key'
+  require 'signing_base'
+  require 'signature_params'
+
+  def initialize(oauth_token, oauth_secret, request_verb, request_path, request_params, nonce, epochtime)
+    @oauth_token = oauth_token
+    @oauth_secret = oauth_secret
+
+    @request_verb = request_verb
+    @request_path = request_path
+    @request_params = request_params
+
+    @nonce = nonce
+    @epochtime = epochtime
+  end
+
+  def digest
+    request_digest = OpenSSL::HMAC.hexdigest('sha1', signing_key, signing_base)
+
+    Base64.encode64(Array(request_digest).pack('H*')).chomp
+  end
+
+  private
+
+  def signing_key
+    SigningKey.new(@oauth_secret).key
+  end
+
+  def signing_base
+    SigningBase.new(@request_verb, @request_path, signature_params).base_string
+  end
+
+  def signature_params
+    SignatureParams.new(@oauth_token, @nonce, @epochtime, @request_params).params
+  end
+end

data/lib/signature_params.rb

@@ -0,0 +1,36 @@
+class SignatureParams
+  require 'active_support'
+  require 'active_support/core_ext'
+
+  require 'twitter_request_headers'
+  require 'escape_uri_string'
+
+  def initialize(oauth_token, nonce, epochtime, request_params)
+    @oauth_token = oauth_token
+    @nonce = nonce
+    @epochtime = epochtime
+    @request_params = request_params.stringify_keys
+  end
+
+  def params
+    params_hash = {
+      'oauth_consumer_key' => TwitterRequestHeaders.consumer_key,
+      'oauth_signature_method' =>	TwitterRequestHeaders.oauth_cipher,
+      'oauth_version' => TwitterRequestHeaders.oauth_version,
+      'oauth_token' => @oauth_token,
+      'oauth_nonce' => @nonce,
+      'oauth_timestamp' => @epochtime
+    }
+
+    params_hash.merge!(@request_params)
+
+    params_array = params_hash.sort.to_h.map do |key, val|
+      escaped_key = EscapeUriString.new(key).escape
+      escaped_val = EscapeUriString.new(val).escape
+
+      "#{escaped_key}=#{escaped_val}"
+    end
+
+    params_array.join('&')
+  end
+end

data/lib/signing_base.rb

@@ -0,0 +1,19 @@
+class SigningBase
+  require 'twitter_request_headers'
+  require 'escape_uri_string'
+
+  def initialize(request_verb, request_path, signature_params)
+    @twitter_api = TwitterRequestHeaders.twitter_api
+    @request_verb = request_verb.upcase
+    @request_path = request_path
+    @signature_params = signature_params
+  end
+
+  def base_string
+    request_uri = "#{@twitter_api}#{@request_path}"
+    escaped_uri = EscapeUriString.new(request_uri).escape
+    escaped_params = EscapeUriString.new(@signature_params).escape
+
+    "#{@request_verb}&#{escaped_uri}&#{escaped_params}"
+  end
+end

data/lib/signing_key.rb

@@ -0,0 +1,16 @@
+class SigningKey
+  require 'twitter_request_headers'
+  require 'escape_uri_string'
+
+  def initialize(oauth_secret)
+    @consumer_secret = TwitterRequestHeaders.consumer_secret
+    @oauth_secret = oauth_secret
+  end
+
+  def key
+    consumer_secret = EscapeUriString.new(@consumer_secret).escape
+    oauth_secret = EscapeUriString.new(@oauth_secret).escape
+
+    "#{consumer_secret}&#{oauth_secret}"
+  end
+end

data/lib/twitter_request_headers.rb

@@ -0,0 +1,66 @@
+class TwitterRequestHeaders
+  require 'signature'
+  require 'header'
+
+  OAUTH_VERSION = '1.0'
+  OAUTH_CIPHER = 'HMAC-SHA1'
+  TWITTER_API = 'https://api.twitter.com/1.1'
+
+  class << self
+    attr_reader :consumer_key, :consumer_secret, :oauth_version, :oauth_cipher, :twitter_api
+
+    def configure(consumer_key, consumer_secret, oauth_version = nil, oauth_cipher = nil, twitter_api = nil)
+      @consumer_key = consumer_key
+      @consumer_secret = consumer_secret
+
+      @oauth_version = oauth_version || OAUTH_VERSION
+      @oauth_cipher = oauth_cipher || OAUTH_CIPHER
+      @twitter_api = twitter_api || TWITTER_API
+
+      @@configured = true
+    end
+  end
+
+
+  def initialize(oauth_token, oauth_secret, request_verb, request_path, request_params = nil)
+    unless @@configured
+      fail StandardError, "Call #{self.class}.configure first!"
+    end
+
+    @oauth_token = oauth_token
+    @oauth_secret = oauth_secret
+
+    @request_verb = request_verb
+    @request_path = request_path
+    @request_params = request_params || {}
+
+    @nonce = nonce
+    @epochtime = epochtime
+  end
+
+  def header
+    signature = Signature.new(
+      @oauth_token,
+      @oauth_secret,
+      @request_verb,
+      @request_path,
+      @request_params,
+      @nonce,
+      @epochtime
+    ).digest
+
+    {
+      Header.key => Header.new(@oauth_token, signature, @nonce, @epochtime).value
+    }
+  end
+
+  private
+
+  def nonce
+    SecureRandom.hex(16)
+  end
+
+  def epochtime
+    Time.now.to_i.to_s
+  end
+end

data/twitter-request-headers.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "twitter-request-headers"
+  spec.version       = '0.0.10'
+  spec.authors       = ["Dmitrii Komaritckii"]
+  spec.email         = ["lochnessathome@gmail.com"]
+
+  spec.summary       = %q{Generates Twitter API's Authorization header}
+  spec.homepage      = "https://github.com/lochnessathome/twitter-request-headers"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+
+  spec.add_runtime_dependency 'activesupport', '~> 4.0'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: twitter-request-headers
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+platform: ruby
+authors:
+- Dmitrii Komaritckii
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- lochnessathome@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/escape_uri_string.rb
+- lib/header.rb
+- lib/signature.rb
+- lib/signature_params.rb
+- lib/signing_base.rb
+- lib/signing_key.rb
+- lib/twitter_request_headers.rb
+- twitter-request-headers.gemspec
+homepage: https://github.com/lochnessathome/twitter-request-headers
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Generates Twitter API's Authorization header
+test_files: []
+has_rdoc: