rainforest_auth 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59e89bf38dee455ed6290f109d81693b0bd6fa47
-  data.tar.gz: a72007dd71e10ec92f00ebd690e829a46517b856
+  metadata.gz: be5c19d4c8f4d0e01ba5d94261ff763089488870
+  data.tar.gz: 91b7aba39ce35a2e527cca72511783f67a7f379e
 SHA512:
-  metadata.gz: 2011c1660738e280e539d28aafb4522718e0aa6a4fec84a19baf6e8bab03f58c2b673cbaaaaf7a2a39fce6c0ad483d9c432c67f0cdbea779b78a7c33b21577cf
-  data.tar.gz: 700a154486f9722a64a53ec802136aeb9e8dace2842f950f7aa137b106797a7401c739d15fbe76a07392986d7f25c8fc004694788d0df7af6c40a030974c42f0
+  metadata.gz: 9553dd2fd085cae0cf93dd03e0f83df97c6c19217165b85f1473900e2bdb0164504c3ca65163ffccd06b1268ec9fd341a8f65e984503dda8e616c724feb0eab4
+  data.tar.gz: c91ba2329d9d06ba4a91ba02245978d9cc9e11d6c2122c2ac44a731c87e69e64f4b741dda394978018ba2dd835360a786393efc699f44b15663088673f1bb013

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+coverage
+rainforest_auth-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--require spec_helper

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.1.1@rainforest-auth --create

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "rake",  ">= 0.8.7"
+end
+
+group :test do
+  gem "jruby-openssl", :platform => :jruby
+  gem "bundler"
+  gem "rspec", ">= 2.0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    rainforest_auth (0.0.10)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    json (1.8.1)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  jruby-openssl
+  rainforest_auth!
+  rake (>= 0.8.7)
+  rspec (>= 2.0)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Michael Bleigh and Intridea, Inc.
+
+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,93 @@
+[![Gem Version](https://badge.fury.io/rb/rainforest_auth.png)](http://badge.fury.io/rb/rainforest_auth)
+[![Build Status](https://travis-ci.org/rainforestapp/auth.png?branch=master)](https://travis-ci.org/rainforestapp/auth)
+[![Dependency Status](https://gemnasium.com/rainforestapp/auth.png)](https://gemnasium.com/rainforestapp/auth)
+
+# Rainforest Auth
+
+Allows verification of [Rainforest](https://www.rainforestqa.com/) webhook messages using your private API key.
+
+## Installation
+
+Rainforest Auth is available as a gem, to install it just install the gem:
+
+    gem install rainforest_auth
+
+If you're using Bundler, add the gem to Gemfile.
+
+    gem 'rainforest_auth'
+
+Then run bundle install.
+
+## Where can I find my API key?
+
+You can find your API key for Rainforest under the [Accounts setting page](https://app.rainforestqa.com/settings/account). If you get stuck finding this, please [reach out](mailto:5h9w4xa0@incoming.intercom.io)!
+
+## Examples
+
+The following example recieves a 'before_run' notification from Rainforest, authenticates it, does a task for you and then notifies Rainforest to continue.
+
+```ruby
+require "rainforest/auth"
+require "httparty"
+
+class RainforestCallbacksController < ApplicationController
+  def create
+    # Check the callback is valid
+    rainforest_auther.run_if_valid(params[:digest], params[:callback_type], params[:options]) do
+
+        # Work out what to do
+        case params[:callback_type]
+            when 'before_run'
+                # Reset the database?
+            when 'after_run'
+                # Trigger deploy!
+        end
+
+        # Get the callback url for this run
+        callback_url = rainforest_auther.get_run_callback(params[:options]['run_id'], params[:callback_type])
+
+        # Notify Rainforest you are ready for a run to start
+        HTTParty.post callback_url
+    end
+  end
+
+private
+  def rainforest_auther
+    @rainforest_auther ||=  RainforestAuth.new 'YOUR_KEY_HERE'
+  end
+end
+```
+
+Checking if the signature is valid;
+
+```ruby
+require "rainforest/auth"
+
+r_auth = RainforestAuth.new('YOUR_KEY_HERE')
+
+# Check the digest is correct
+if r_auth.verify digest, callback_type, options
+    puts "The digest was valid."
+else
+    puts "The digest was invalid!"
+end
+```
+
+Running a block if the signature is valid;
+
+```ruby
+require "rainforest/auth"
+
+r_auth = RainforestAuth.new('YOUR_KEY_HERE')
+
+# Run a block if it works
+r_auth.run_if_valid(digest, callback_type, options) {
+    puts "The digest was valid."
+}
+```
+
+## License
+MIT License. See [LICENSE](/rainforestapp/auth/blob/master/LICENSE) for details.
+
+## Copyright
+Copyright (c) 2014 CLDRDR, Inc.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/rainforest_auth.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name          = "rainforest_auth"
+  s.version       = "0.0.10"
+  s.date          = "2014-02-13"
+  s.summary       = "Authentication of messages for Rainforest webhooks"
+  s.description   = "Signs / Authenticates messages"
+  s.authors       = ["Russell Smith"]
+  s.email         = ["russ@rainforestqa.com"]
+  s.files         = ["lib/rainforest/auth.rb"]
+  s.homepage      = "https://www.rainforestqa.com/"
+  s.require_paths = ["lib"]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.add_dependency('json')
+end

data/spec/rainforest_auth_spec.rb

@@ -0,0 +1,102 @@
+describe RainforestAuth do
+  context "#new" do
+    it "stores the key" do
+      auth = RainforestAuth.new('key')
+      auth.key.should == 'key'
+    end
+
+    it "returns itself" do
+      RainforestAuth.new('key').should be_an_instance_of RainforestAuth
+    end
+  end
+
+  context ".get_run_callback" do
+    before :all do
+      @run_id = '123456'
+      @auth = RainforestAuth.new('key')
+
+      @url = @auth.get_run_callback(@run_id, 'before_run')
+      @url_split = @url.split '/'
+    end
+
+    it "returns a url" do
+      @url[0..4].should == 'https'
+    end
+
+    it "has the correct run_id" do
+      @url_split[7].should == @run_id
+    end
+
+    it "has the correct action" do
+      @url_split[8].should == 'before_run'
+    end
+
+    it "has the correct digest" do
+      digest = @url_split[9]
+      @auth.verify(digest, 'before_run', {:run_id => @run_id}).should be_true
+    end
+  end
+
+  context ".sign" do
+    before :all do
+      @auth = RainforestAuth.new('key')
+    end
+
+    it "returns the expected signature" do
+      @auth.sign('test', {:option => 1}).should == '5957ba2707a51852d32309d16184e8adce9c4d8e'
+    end
+
+    it "changes the signature with different data" do
+      @auth.sign('test', {:option => 2}).should_not == '5957ba2707a51852d32309d16184e8adce9c4d8e'
+    end
+
+    it "works with no options parameter" do
+      @auth.sign('test').should == '0a41bdf26fac08a89573a7f5efe0a5145f2730df'
+    end
+  end
+
+  context ".verify" do
+    before :all do
+      @auth = RainforestAuth.new('key')
+      @digest = '5957ba2707a51852d32309d16184e8adce9c4d8e'
+    end
+
+    it "returns true for a valid signature" do
+      @auth.verify(@digest, 'test', {:option => 1}).should be_true
+    end
+
+    it "returns false for a bad signature" do
+      @auth.verify(@digest, 'test', {:option => 2}).should be_false
+    end
+
+    it "works with no options parameter" do
+      @auth.verify('0a41bdf26fac08a89573a7f5efe0a5145f2730df', 'test').should be_true
+    end
+  end
+
+  context ".run_if_valid" do
+    before :all do
+      @auth = RainforestAuth.new('key')
+      @object = "test"
+      @object.stub(:some_method) { 3 }
+
+      @digest = '5957ba2707a51852d32309d16184e8adce9c4d8e'
+    end
+
+    it "executes the block if there is a valid signature" do
+      @object.should_receive :some_method
+
+      @auth.run_if_valid(@digest, 'test', {:option => 1}) {
+        @object.some_method
+      }
+    end
+
+    it "does not execute the block for invalid signatures" do
+      @object.should_not_receive :some_method
+
+      @auth.run_if_valid(@digest, 'test', {:option => 2}) {
+        @object.some_method
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+
+ENV["RACK_ENV"] ||= 'test'
+
+require File.expand_path('../lib/rainforest/auth', File.dirname(__FILE__))
+
+# Configure rspec
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rainforest_auth
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Russell Smith
@@ -31,7 +31,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".rvmrc"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
 - lib/rainforest/auth.rb
+- rainforest_auth.gemspec
+- spec/rainforest_auth_spec.rb
+- spec/spec_helper.rb
 homepage: https://www.rainforestqa.com/
 licenses: []
 metadata: {}
@@ -55,4 +67,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Authentication of messages for Rainforest webhooks
-test_files: []
+test_files:
+- spec/rainforest_auth_spec.rb
+- spec/spec_helper.rb