signed_parameters 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c8be0169eeedb917b05bda02043e41fa0ae0bad
+  data.tar.gz: 92d935701596c8ca75206541ce3c706ad6a74fc7
+SHA512:
+  metadata.gz: 2f25316bf6a23ede20f549c1b5eae24c704e1a76139be7aec332e5dc3ad3f8bd9a5118ce828b55f48947c01a022d2c6805db1a1af654f56fa1a8fe88a86f361a
+  data.tar.gz: e7bcf8acfe8aa9e100d7d875f77afefde21ed720257ff8176d299e3754520903265c77cdb3caf4c92ae2830aa7219d483bda9faf0d78f0f6d01ba5942954253d

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 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - '2.1.0'
+script: bundle exec rspec spec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Evgeniy Serykh
+
+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,80 @@
+[![Build Status](https://travis-ci.org/evserykh/signed_parameters.svg?branch=master)](https://travis-ci.org/evserykh/signed_parameters) [![Dependency Status](https://gemnasium.com/evserykh/signed_parameters.svg)](https://gemnasium.com/evserykh/signed_parameters)
+***
+# SignedParameters
+
+Allow to sign data with secret key
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'signed_parameters'
+
+And then execute:
+
+    $ bundle
+    
+##How it works
+
+Assume, the both sides know secret key, and one of them must send a data to another, and another side must receive the data and verify the data is signed with correct key. 
+
+The sending side gets the sign and adds it to sending data, the receiving side does the same things with received data and compares obtained sign with received sign.    
+
+## Algorithm of computing of sign
+
+1. Build an array of values to be sended
+2. Remove from the array empty values
+3. Sort the array
+4. Add secret key to the end of array
+5. Join elements of array into a string
+6. Compute the SHA-1 digest from the string from step 5
+7. Compute the MD5 digest from the string from step 6
+
+## Example
+
+The sending data are { :email => 'test@test.com', :username => 'John Smith', :age => 66, :address => '' }
+
+The secret key is c5fc6b5cff2d52791ecaae659200de5e
+
+Step 1. [ 'test@test.com', 'John Smith', 66, '' ]
+
+Step 2. [ 'test@test.com', 'John Smith', 66 ]
+
+Step 3. [ 66, 'John Smith', 'test@test.com' ]
+
+Step 4. [ 66, 'John Smith', 'test@test.com', 'c5fc6b5cff2d52791ecaae659200de5e' ]
+
+Step 5. str = 66;John Smith;test@test.com;c5fc6b5cff2d52791ecaae659200de5e
+
+Step 6. sha1 = SHA1(str)
+
+Step 7. md5 = MD5(sha1)
+
+So, for the data { :email => 'test@test.com', :username => 'John Smith', :age => 66, :address => '' } the sign will be 0fc248b16df686b7fcb5c5dc9ce701d
+
+## Usage
+
+```ruby
+> params = { :email => 'test@test.com', :username => 'John Smith', :age => 66, :address => ''  }
+ => {:email=>"test@test.com", :username=>"John Smith", :age=>66, :address=>""} 
+> secret = 'c5fc6b5cff2d52791ecaae659200de5e'
+ => "c5fc6b5cff2d52791ecaae659200de5e" 
+> SignedParameters.to_query(params, secret)
+ => "age=66&email=test%40test.com&sign=0fc248b16df686b7fcb5c5dc9ce701d8&username=John+Smith"
+```
+or
+```ruby
+> builder = SignedParameters::Builder.new(params, secret)
+ => #<SignedParameters::Builder:0x007f8f8835c770 @parameters={:email=>"test@test.com", :username=>"John Smith", :age=>66, :address=>""}, @secret="c5fc6b5cff2d52791ecaae659200de5e", @separator=";"> 
+> builder.sign
+ => "0fc248b16df686b7fcb5c5dc9ce701d8"
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/signed_parameters/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/lib/signed_parameters/builder.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/string'
+
+module SignedParameters
+  class Builder
+    def initialize(parameters, secret, separator = ';')
+      @parameters = parameters
+      @secret = secret
+      @separator = separator
+    end
+
+    def sign
+      md5
+    end
+
+    def parameters_with_sign
+      used_parameters.merge :sign => sign
+    end
+
+    def to_query
+      parameters_with_sign.to_query
+    end
+
+    private
+
+    def used_parameters
+      @parameters.select { |k, v| v.present? }
+    end
+
+    def sorted_parameters_values
+      used_parameters.values.map(&:to_s).sort
+    end
+
+    def string_for_sign
+      (sorted_parameters_values + [@secret]).join @separator
+    end
+
+    def sha1
+      Digest::SHA1.hexdigest string_for_sign
+    end
+
+    def md5
+      Digest::MD5.hexdigest sha1
+    end
+  end
+end

data/lib/signed_parameters/version.rb

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

data/lib/signed_parameters.rb

@@ -0,0 +1,8 @@
+require 'signed_parameters/version'
+require 'signed_parameters/builder'
+
+module SignedParameters
+  def self.to_query(parameters, secret)
+    Builder.new(parameters, secret).to_query
+  end
+end

data/signed_parameters.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'signed_parameters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "signed_parameters"
+  spec.version       = SignedParameters::VERSION
+  spec.authors       = ["Evgeniy Serykh"]
+  spec.email         = ["e.v.serykh@gmail.com"]
+  spec.summary       = %q{Signed parameters}
+  spec.description   = %q{Signed parameters}
+  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 'activesupport', '>= 2.2.1'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/signed_parameters/builder_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe SignedParameters::Builder do
+  let(:params) { { :foo => 'foo', :bar => :bar, :baz => '', 'qux' => 42 } }
+  let(:secret) { 'some secret token' }
+  let(:separator) { ';' }
+
+  let(:sign) { '17223137b3c5f28247367deb3f86dc9d' }
+
+  subject { SignedParameters::Builder.new params, secret, separator }
+
+  describe '#used_parameters' do
+    its(:used_parameters) { should == { :foo => 'foo', :bar => :bar, 'qux' => 42 } }
+  end
+
+  describe '#sorted_parameters_values' do
+    its(:sorted_parameters_values) { should == ['42', 'bar', 'foo'] }
+  end
+
+  describe '#string_for_sign' do
+    its(:string_for_sign) { should == '42;bar;foo;some secret token' }
+  end
+
+  describe '#sign' do
+    its(:sign)  { should == sign }
+  end
+
+  describe '#parameters_with_sign' do
+    its(:parameters_with_sign) { should == { :foo => 'foo', :bar => :bar, 'qux' => 42, :sign => sign } }
+  end
+
+  describe '#to_query' do
+    its(:to_query) { should == 'bar=bar&foo=foo&qux=42&sign=17223137b3c5f28247367deb3f86dc9d' }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require File.expand_path('../../lib/signed_parameters', __FILE__)

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: signed_parameters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evgeniy Serykh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !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'
+description: Signed parameters
+email:
+- e.v.serykh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/signed_parameters.rb
+- lib/signed_parameters/builder.rb
+- lib/signed_parameters/version.rb
+- signed_parameters.gemspec
+- spec/signed_parameters/builder_spec.rb
+- spec/spec_helper.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: Signed parameters
+test_files:
+- spec/signed_parameters/builder_spec.rb
+- spec/spec_helper.rb