basic_api_auth 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2f5c819cc5ce307afaf1537c08808d57574318b
+  data.tar.gz: 6ea12981c89456c47e5dd086929db7128bb359a2
+SHA512:
+  metadata.gz: d39a71f5775fc97ee72321c5df225b09c1efd074a63f4871711132b409909939280d87c5854cd2d432944202c378f0e18e3439646b0ea2232edbbeecf25bdc5c
+  data.tar.gz: 17ec5e84914e841bc463469e2270d51488c9bc74983865d62d526ea6c611140cb712a85637f0a9afebe22bd399fe74bf04df910615417f803eaedf7ac207d790

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gautam Naroji
+
+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,38 @@
+# BasicApiAuth
+A basic SHA1 hashkey based authentication implementation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'basic_api_auth'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install basic_api_auth
+
+## Usage
+
+create a yml file with an authentication key as follows:
+in config/basic_api_auth_key.yml
+api_key: 'API-KEY-HERE'
+
+## Generation of Hashkey
+The hashkey sent to the api call should be generated by following these steps
+1. Order all the parameters of the cal in alphabetic order of its keys
+2. Convert them into a string representation such that, if the hash is of type {name: 'snarf'} then its string representation would be "name=snarf"
+3. Append the api key given to you to the string after adding a "&" so the resulting string will become "name=snarf&API-KEY-HERE"
+4. Use SHA1 to generate a hashkey from the resulting string
+5. Append the generated hashkey as a paramter of the API call
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/basic_api_auth/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/basic_api_auth.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'basic_api_auth/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "basic_api_auth"
+  spec.version       = BasicApiAuth::VERSION
+  spec.authors       = ["Gautam Naroji"]
+  spec.email         = ["gautam@appyantra.com"]
+  spec.summary       = %q{Basic authentication for simple API implementations}
+  spec.description   = %q{SHA1 Hashkey based authentication for simple API engine}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "json"
+end

data/lib/basic_api_auth.rb

@@ -0,0 +1,28 @@
+require "basic_api_auth/version"
+require "hashkey_generator"
+require 'basic_api_auth/railtie' if defined?(Rails)
+
+module BasicApiAuth
+  class Middleware
+    include HashkeyGenerator
+    @@authenticity_error = [401, {"Content-Type" => "text/plain"}, ['{ "message": "Authentication Failed" }']]
+    @@hashkey_requirement_error = [401, {"Content-Type" => "text/plain"}, ['{ "message": "Hashkey is required for authentication" }']]
+
+    def initialize(app, api_key)
+      @app = app
+      @api_key = api_key
+    end
+
+    def call(env)
+      @params = Rack::Request.new(env).params
+      @hashkey = @params.delete('hashkey')
+      return @@hashkey_requirement_error unless @hashkey
+      return @@authenticity_error unless authenticate_hashkey
+      @app.call(env)
+    end
+
+    def authenticate_hashkey
+      @hashkey == generate_hashkey_for(@params, @api_key)
+    end
+  end
+end

data/lib/basic_api_auth/railtie.rb

@@ -0,0 +1,9 @@
+module BasicApiAuth
+  class Railtie < Rails::Railtie
+    initializer "basic_api_auth_railtie.configure_rails_initialization" do |config|
+      api_key = YAML.load_file("#{Rails.root}/config/basic_api_auth_key.yml")["api_key"].to_s
+      config.middleware.use BasicApiAuth::Middleware, api_key
+    end
+  end
+
+end

data/lib/basic_api_auth/version.rb

@@ -0,0 +1,3 @@
+module BasicApiAuth
+  VERSION = "1.0.0"
+end

data/lib/hashkey_generator.rb

@@ -0,0 +1,26 @@
+require 'digest/sha1'
+
+module HashkeyGenerator
+  # create a string representation of passed hash, which can be encoded in a URL
+  def concat_params(params)
+    result = ""
+    return result if params.empty?
+    params.map{|key,val| result += "#{key}=#{val}&" unless val.nil? or val == ''}
+    result.chomp!('&')
+  end
+
+  # sort the parameters in alphabetical order of keys
+  def sort_params(params)
+    Hash[params.sort]
+  end
+
+  # Generate a hashkey using SHA1 for a provided API key
+  # List of parameters
+  # *params : a list of parameters as a hash, that needs to be used for hashkey generation
+  # *api_key: a unique API key provided to you for authenticating the API calls
+  def generate_hashkey_for(params, api_key)
+    sorted_params = sort_params(params)
+    params_string = concat_params(sorted_params)
+    Digest::SHA1.hexdigest "#{params_string}&#{api_key}"
+  end
+end

data/spec/lib/basic_api_auth_spec.rb

@@ -0,0 +1,28 @@
+RSpec.describe BasicApiAuth, :type => :module do
+  let(:app) {
+    Rack::Builder.new do
+      use BasicApiAuth::Middleware, "snaf-test"
+      run lambda { |env| [200, {'Content-Type' => 'text/plain'}, ["Testing Basic APi Auth!"]] }
+    end
+  }
+
+  describe BasicApiAuth::Middleware do
+
+    it "is successful if passed hashkey is correct" do
+      response = Rack::MockRequest.new(app).get('/api/snarf_test?hashkey=350d806c45699b4db9bdf0113505f0bac07526a6&param_a=snarf')
+      response.status.should == 200
+    end
+
+    it "returns 401 if hashkey authentication fails" do
+      response = Rack::MockRequest.new(app).get('/api/test?hashkey=failedkey&param_a=snarf')
+      response.status.should == 401
+      JSON.parse(response.body).should == { "message" => "Authentication Failed" }
+    end
+
+    it "returns 401 - hashkey required, if hashkey is not passed" do
+      response = Rack::MockRequest.new(app).get('/api/test?param_a=snarf')
+      response.status.should == 401
+      JSON.parse(response.body).should == { "message" => "Hashkey is required for authentication" }
+    end
+  end
+end

data/spec/lib/hashkey_generator_spec.rb

@@ -0,0 +1,31 @@
+RSpec.describe HashkeyGenerator, :type => :module do
+
+  let(:generator_class) { class HashkeyGeneratorTest; extend HashkeyGenerator; end }
+
+  context "#concat_params" do
+    let(:params)      { { operation: :add, operand_a: 1, operand_b: 2 } }
+    let(:expectation) { "operation=add&operand_a=1&operand_b=2" }
+
+    it "can concat a hash parameters into a string representation" do
+      expect(generator_class.concat_params(params)).to eq expectation
+    end
+
+    it "returns empty string is empty params hash ispassed" do
+      expect(generator_class.concat_params({})).to eq ""
+    end
+
+    it "omits hash key-pairs that have empty or nil values" do
+      expect(generator_class.concat_params({a: nil, b: '', c: 12})).to eq "c=12"
+    end
+  end
+
+  context "#sort_params" do
+    let(:params)      { { operation: :add, operand_a: 1, operand_b: 2 } }
+    let(:expectation) { { operand_a: 1, operand_b: 2, operation: :add } }
+
+    it "sorts a hash in alphabetical order of its keys" do
+      expect(generator_class.sort_params(params)).to eq expectation
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rack/mock'
+require 'json'
+require 'pry'
+
+Dir[File.expand_path("../../lib/*.rb", __FILE__)].each { |f| require f }
+Dir[File.expand_path("../support/*.rb", __FILE__)].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

data/spec/support/factories.rb

@@ -0,0 +1,6 @@
+module Factories
+end
+
+RSpec.configure do |c|
+  c.include Factories
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: basic_api_auth
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Gautam Naroji
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SHA1 Hashkey based authentication for simple API engine
+email:
+- gautam@appyantra.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- basic_api_auth.gemspec
+- lib/basic_api_auth.rb
+- lib/basic_api_auth/railtie.rb
+- lib/basic_api_auth/version.rb
+- lib/hashkey_generator.rb
+- spec/lib/basic_api_auth_spec.rb
+- spec/lib/hashkey_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Basic authentication for simple API implementations
+test_files:
+- spec/lib/basic_api_auth_spec.rb
+- spec/lib/hashkey_generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb