doyoubuzz-showcase 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ca622ca780c6a6ae46844f5dc79b9829853d762
-  data.tar.gz: ed83ff11c9e0a86112031b411d917e5332465287
+  metadata.gz: 2aceb417792c107337b13ac22cfe4226fcddd93b
+  data.tar.gz: 6bbf214f97889a7439ed418b6e30d9761d54d426
 SHA512:
-  metadata.gz: 690bc10606bfcca681a22504807f92c49f5a42b19a8ec9cf6baa66c06b11db0106d379e70802939d3d07eba8f7396d277c2caf52f2a8f724d6279e9b074daae0
-  data.tar.gz: 7df9e9526cc9b5cabb51b50bf031ee8696fecf095e854de3ff233ff288ad9cfb48e685a643d04465c5ef5ef2753db122611a92a0d153146bd99bacfa4cc57cd5
+  metadata.gz: 464aee41aa33f7a9fcef0cae09e9864fcafcbbcd32efc6928ddebac83596474836b6d503920273a46611b34649b3b2f0d3c123f881ad08f5bd561b0cc7acb277
+  data.tar.gz: b2e5ef907ef149ac4dad612837edbd09be5196bad01aef7ef3b4db88eef96a17c7bb386926ab97a93d5b9c27b496a257db0dd2ad9aa9e3705cb46464982af1cd

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.3
+
+### Breaking Updates
+ * require HTTParty >= 0.13 
+ * require hashie >= 3.3.2
+
+### CHANGELOG
+ * [DEV] Update rspec to v3
+ * Add Travis and Coveralls integration

data/Gemfile

@@ -1,9 +1,12 @@
 source 'https://rubygems.org'
 
 # Developpement dependencies
-gem 'rspec',    '~> 2.13'
-gem 'webmock',  '~> 1.11'
-gem 'vcr',      '~> 2.5'
+gem 'rspec',    '~> 3.1'
+gem 'webmock',  '~> 1.20'
+gem 'vcr',      '~> 2.9'
+
+# CI
+gem 'coveralls', :require => false
 
 # Specify the gem's dependencies in doyoubuzz-showcase.gemspec
 gemspec

data/README.md

@@ -1,3 +1,6 @@
+
+[![Gem Version](https://badge.fury.io/rb/doyoubuzz-showcase.svg)](http://badge.fury.io/rb/doyoubuzz-showcase) [![Build Status](https://api.travis-ci.org/mru2/doyoubuzz-showcase.svg)](https://travis-ci.org/mru2/doyoubuzz-showcase) [![Coverage Status](https://coveralls.io/repos/mru2/doyoubuzz-showcase/badge.png?branch=master)](https://coveralls.io/r/mru2/doyoubuzz-showcase?branch=master) [![Code Climate](https://codeclimate.com/github/mru2/doyoubuzz-showcase/badges/gpa.svg)](https://codeclimate.com/github/mru2/doyoubuzz-showcase)
+
 # Doyoubuzz::Showcase
 
 ## Description

data/doyoubuzz-showcase.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
 
-  spec.add_dependency "httparty", "~> 0.11"
-  spec.add_dependency "hashie", "~> 2.0"
+  spec.add_dependency "httparty", "~> 0.13"
+  spec.add_dependency "hashie", ">= 2.1.2"
 end

data/lib/doyoubuzz/showcase.rb

@@ -1,6 +1,8 @@
 require 'httparty'
 require 'hashie/mash'
 
+require 'doyoubuzz/showcase/error'
+
 module Doyoubuzz
   class Showcase
 
@@ -20,6 +22,19 @@ module Doyoubuzz
       end
     end
 
+    # SSO redirection
+    def sso_redirect_url(application_name, timestamp, sso_key, user_attributes)
+      # Check mandatory attributes are given
+      missing_attributes = [:email, :external_id, :firstname, :lastname].reject{|key| user_attributes[key]}
+
+      if missing_attributes.length > 0
+        raise ArgumentError, "Missing mandatory attributes for SSO : #{missing_attributes.join(', ')}"
+      end
+
+      params = sign_sso_params(user_attributes.merge(timestamp: timestamp), sso_key)
+
+      "http://showcase.doyoubuzz.com/p/fr/#{application_name}/sso?#{URI.encode_www_form(params)}"
+    end
 
 
     private
@@ -33,7 +48,7 @@ module Doyoubuzz
     # Process the HTTParty response, checking for errors
     def process_response(res)
       if !res.success?
-        raise HTTParty::ResponseError.new(res.response)
+        raise Error.new(res.code, res.body)
       end
 
       if res.is_a? Hash
@@ -51,35 +66,36 @@ module Doyoubuzz
 
       # GET, DELETE requests : the parameters are in the request query
       if [:get, :delete].include? verb
-        return {:query => sign_params(params.merge additional_parameters)}
+        return {:query => sign_api_params(params.merge additional_parameters)}
 
       # Otherwise, they are in the body
       else
-        return {:body => params, :query => sign_params(additional_parameters)}
+        return {:body => params, :query => sign_api_params(additional_parameters)}
       end
     end
 
 
     # The arguments processing and signing
-    def sign_params(params)
-      params[:hash] = compute_signature(params)
-      params
-    end
-
-    # Computing the parameters signature hash
-    # Algorithm :
-    # - Order parameters by key
-    # - Concatenate their values
-    # - Append the current timestamp
-    # - Append the api secret
-    # - MD5 the resulting string
-    def compute_signature(params)
+    def sign_api_params(params)
       ordered_params_values = params.sort.map{|k,v|v}
       concatenated_params_string = ordered_params_values.join
-      concatenated_params_string << @api_secret
+      concatenated_params_string << secret_key
+
+      hash = Digest::MD5.hexdigest(concatenated_params_string)
+      params.merge(hash: hash)
+    end
 
-      return Digest::MD5.hexdigest(concatenated_params_string)
+    # Different ordering
+    def sign_sso_params(params, sso_key)
+      # Custom ordering
+      tosign = params.values_at(:email, :firstname, :lastname, :external_id, :"group[]", :user_type, :timestamp).compact.join
+      tosign += sso_key
+
+      hash = Digest::MD5.hexdigest(tosign)
+
+      params.merge(hash: hash)
     end
 
+
   end
 end

data/lib/doyoubuzz/showcase/error.rb

@@ -0,0 +1,25 @@
+module Doyoubuzz
+  class Showcase
+    class Error < ::StandardError
+      attr_reader :status
+
+      def initialize(status, response_body)
+        # Try to extract a meaningful message from the error
+        message = begin
+          parsed_body = JSON.parse(response_body)
+          parsed_body['error']['message']
+        rescue  => e
+          response_body
+        end
+
+        super(message)
+        @status = status
+      end
+
+      def inspect
+        "#<Doyoubuzz::Showcase::Error #{status}: #{message}>"
+      end
+
+    end
+  end
+end

data/lib/doyoubuzz/showcase/version.rb

@@ -1,3 +1,3 @@
 module Doyoubuzz
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/showcase_spec.rb

@@ -6,6 +6,7 @@ describe Doyoubuzz::Showcase do
 
   let(:api_key){ 'an_api_key' }
   let(:api_secret){ 'an_api_secret' }
+  let(:showcase){ Doyoubuzz::Showcase.new(api_key, api_secret) }
 
   describe '#new' do
     it 'should require an api key and secret key' do
@@ -16,29 +17,28 @@ describe Doyoubuzz::Showcase do
   end
 
   describe '#call' do
-    let(:showcase){ Doyoubuzz::Showcase.new(api_key, api_secret) }
     let(:arguments){ {:foo => 'bar', :zab => 'baz'} }
     let(:timestamp){ 1370534334 }
 
     # The timestamp is important in the request generation and the VCR handling. Here it is set at a fixed date
     before(:each) do
       time = Time.at(timestamp)
-      Time.stub!(:now).and_return time
+      allow(Time).to receive(:now).and_return time
     end
 
     it "should compute a valid signature" do
-      Doyoubuzz::Showcase.new('IuQSDLKQLSDK344590Li987', 'IuJyt42BnUiOlPM8FvB67tG').send(:compute_signature, {:apikey => 'IuQSDLKQLSDK344590Li987', :timestamp => timestamp}).should == '1dd33466d71275d06c9e17e18235c9f0'
+      Doyoubuzz::Showcase.new('IuQSDLKQLSDK344590Li987', 'IuJyt42BnUiOlPM8FvB67tG').send(:compute_signature, {:apikey => 'IuQSDLKQLSDK344590Li987', :timestamp => timestamp}, 'IuJyt42BnUiOlPM8FvB67tG').should == '1dd33466d71275d06c9e17e18235c9f0'
     end
 
     it "should generate a valid signed api call" do
-      showcase.stub!(:process_response) # We only want to check the sent parameters here
+      allow(showcase).to receive(:process_response) # We only want to check the sent parameters here
       showcase.class.should_receive(:get).with("/path", {:query => {:foo => "bar", :zab => "baz", :apikey => "an_api_key", :timestamp => timestamp, :hash => "757b04a866f1d02f077471589341ff7a"}})
 
       showcase.get('/path', arguments)
     end
 
     it "should put the parameters in the body for PUT requests" do
-      showcase.stub!(:process_response) # We only want to check the sent parameters here
+      allow(showcase).to receive(:process_response) # We only want to check the sent parameters here
       showcase.class.should_receive(:put).with("/path", {:query => {:apikey => "an_api_key", :timestamp => timestamp, :hash => "11a68a1bb9e23c681438efb714c9ad4d"}, :body => {:foo => "bar", :zab => "baz"}})
 
       showcase.put('/path', arguments)
@@ -75,12 +75,46 @@ describe Doyoubuzz::Showcase do
     it "should raise an exception on a failed call" do
       VCR.use_cassette("failed_call") do
         expect{ res = showcase.get('/users') }.to raise_error do |error|
-          error.should be_a(HTTParty::ResponseError)
-          error.response.should == Net::HTTPForbidden
+          error.should be_a(Doyoubuzz::Showcase::Error)
+          error.status.should == 403
+          error.message.should == "Forbidden"
+          error.inspect.should == "#<Doyoubuzz::Showcase::Error 403: Forbidden>"
         end
       end
     end
 
   end
 
+
+  describe '#sso_redirect_url' do
+
+    let(:company_name){ 'my_company' }
+    let(:timestamp){ 1370534334 }
+    let(:user_attributes){ 
+      {
+        email: 'email@host.tld',
+        firstname: 'John',
+        lastname: 'Doe',
+        external_id: 12345
+      }
+    }
+    let(:sso_key){ 'vpsdihgfdso' }
+
+    it "should verify all the mandatory user attributes are given" do
+
+      user_attributes.keys.each do |mandatory_key|
+
+        incomplete_attributes = user_attributes.dup.tap{|attrs|attrs.delete mandatory_key}
+        expect { showcase.sso_redirect_url(company_name, timestamp, sso_key, incomplete_attributes) }.to raise_error ArgumentError, "Missing mandatory attributes for SSO : #{mandatory_key}"
+
+      end
+
+    end
+
+    it "should compute the right url" do
+      showcase.sso_redirect_url(company_name, timestamp, sso_key, user_attributes).should == 'http://showcase.doyoubuzz.com/p/fr/my_company/sso?email=email%40host.tld&firstname=John&lastname=Doe&external_id=12345&timestamp=1370534334&hash=d6bbfc7ead803a3578887d6429d60047'
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -3,6 +3,9 @@ require 'bundler/setup'
 
 require 'vcr'
 
+require 'coveralls'
+Coveralls.wear!
+
 VCR.configure do |conf|
   conf.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   conf.hook_into :webmock

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: doyoubuzz-showcase
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - David RUYER
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-14 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.1.2
 description: Wrapper around the DoYouBuzz showcase API
 email:
 - david.ruyer@gmail.com
@@ -73,14 +73,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - doyoubuzz-showcase.gemspec
 - lib/doyoubuzz/showcase.rb
+- lib/doyoubuzz/showcase/error.rb
 - lib/doyoubuzz/showcase/version.rb
 - spec/fixtures/vcr_cassettes/failed_call.yml
 - spec/fixtures/vcr_cassettes/good_call.yml
@@ -96,17 +100,17 @@ 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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Wrapper around the DoYouBuzz showcase API
@@ -115,3 +119,4 @@ test_files:
 - spec/fixtures/vcr_cassettes/good_call.yml
 - spec/showcase_spec.rb
 - spec/spec_helper.rb
+has_rdoc: