doyoubuzz-showcase 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70f12625b52caebe5f3d707d714cd2c0f95ea309
-  data.tar.gz: 80838e39ed9189bb9e2393d2f6756ae9bd024dc0
+  metadata.gz: dab8e4fc67a92861f80a0962dc11196af652b45f
+  data.tar.gz: 0da1bb56b4b0767aa2dab2fdfc4c4a9e90133408
 SHA512:
-  metadata.gz: 1894f5dd1110f31614346d605307da9dc82e102d2423d8c49d7399473b7e94b344acb3adea419fff5db23f655a1d955bc96716ac3cdc4993da386260d79b5ac8
-  data.tar.gz: c7443d57d9b68d1c2cc462af7d69109f8793906c6e29bd8e93b50b17995d91c8a2b6783bb26216899b2b6421390b7dfc62b837686419b40d31d16274f63436b3
+  metadata.gz: cc792af5f1ad68ebef798ce0953cc9e4c67527d6554a9a05a914c993f6bf1e5c77982b12c8fdb0a1c00557461021fc543d7a8b7199ec12044194273e9ba76559
+  data.tar.gz: 8c46d78bb80288218b1a6fc12c2f3581d735a95a6973d8a530cb8aae156381c99fc3546f550425d99e7231fb27132f143429c521d086f515da60923332cb48bf

data/.rspec

@@ -1 +1,2 @@
 --color
+--format documentation

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 
 rvm:
   - 2.1.0
-  - 2.0.0
-  - 1.9.3
+  - 2.2.3
+  - 2.3.0
 
-script: bundle exec rspec spec
+script: bundle exec rspec spec

data/Gemfile

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

data/README.md

@@ -11,6 +11,7 @@ The `doyoubuzz-showcase` gem is a thin ruby wrapper for the DoYouBuzz Showcase A
 
 - httparty
 - hashie
+- ruby >= 2.1.0
 
 ## Installation
 

data/doyoubuzz-showcase.gemspec

@@ -4,23 +4,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'doyoubuzz/showcase/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "doyoubuzz-showcase"
+  spec.name          = 'doyoubuzz-showcase'
   spec.version       = Doyoubuzz::VERSION
-  spec.authors       = ["David RUYER"]
-  spec.email         = ["david.ruyer@gmail.com"]
-  spec.description   = %q{Wrapper around the DoYouBuzz showcase API}
-  spec.summary       = %q{Wrapper around the DoYouBuzz showcase API}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['David RUYER']
+  spec.email         = ['david.ruyer@gmail.com']
+  spec.description   = 'Wrapper around the DoYouBuzz showcase API'
+  spec.summary       = 'Wrapper around the DoYouBuzz showcase API'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   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.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
 
-  spec.add_dependency "httparty", "~> 0.13"
-  spec.add_dependency "hashie", ">= 2.1.2"
+  spec.add_dependency 'httparty', '~> 0.13'
+  spec.add_dependency 'hashie', '>= 3.5.0'
 end

data/lib/doyoubuzz/showcase.rb

@@ -1,3 +1,4 @@
+require 'logger'
 require 'httparty'
 require 'hashie/mash'
 
@@ -9,6 +10,8 @@ module Doyoubuzz
     include HTTParty
     base_uri 'http://showcase.doyoubuzz.com/api/v1'
 
+    Hashie.logger = ::Logger.new(STDOUT)
+
     # Construction with mandatory api key and api secret
     def initialize(api_key, api_secret)
       @api_key = api_key
@@ -16,68 +19,58 @@ module Doyoubuzz
     end
 
     # HTTP calls => forwarded to #call_api with the verb as the first argument
-    [:get, :post, :put, :delete].each do |verb|
-      define_method(verb) do |method, params = {}|
+    %i(get post put delete).each do |verb|
+      define_method(verb) do |method, params={}|
         call_api(verb, method, params)
       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
 
     # The actual api call
     def call_api(verb, method, params)
-      res = self.class.send(verb, method, build_request_parameters(params, verb))
-      return process_response(res)
+      res = self.class.send(
+        verb,
+        method,
+        build_request_parameters(params, verb)
+      )
+
+      process_response(res)
     end
 
     # Process the HTTParty response, checking for errors
     def process_response(res)
-      if !res.success?
-        raise Error.new(res.code, res.body)
-      end
+      raise Error.new(res.code, res.body) unless res.success?
+
+      object = res.parsed_response
 
-      if res.is_a? Hash
-        return Hashie::Mash.new(res)
-      elsif res.is_a? Array
-        return res.map{|item| Hashie::Mash.new(item)}
-      else
-        return res
+      case object
+      when Hash then mash(object)
+      when Array then object.map(&method(:mash))
+      else object
       end
     end
 
+    def mash(object)
+      Hashie::Mash.new(object)
+    end
+
     # Build the request parameters
     def build_request_parameters(params, verb)
-      additional_parameters = {:apikey => @api_key, :timestamp => Time.now.to_i}
+      additional_parameters = { apikey: @api_key, timestamp: Time.now.to_i }
 
       # GET, DELETE requests : the parameters are in the request query
-      if [:get, :delete].include? verb
-        return {:query => sign_api_params(params.merge additional_parameters)}
+      if %i(get delete).include?(verb)
+        return { query: sign_api_params(params.merge(additional_parameters)) }
+      end
 
       # Otherwise, they are in the body
-      else
-        return {:body => params, :query => sign_api_params(additional_parameters)}
-      end
+      { body: params, query: sign_api_params(additional_parameters) }
     end
 
-
     # The arguments processing and signing
     def sign_api_params(params)
-      ordered_params_values = params.sort.map{|k,v|v}
+      ordered_params_values = params.sort.map { |_, v| v }
       concatenated_params_string = ordered_params_values.join
       concatenated_params_string << @api_secret
 
@@ -85,17 +78,5 @@ module Doyoubuzz
       params.merge(hash: hash)
     end
 
-    # 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/sso.rb

@@ -0,0 +1,52 @@
+module Doyoubuzz
+  class Showcase
+    class SSO
+
+      BASE_URL = 'http://showcase.doyoubuzz.com'.freeze
+
+      def initialize(application, key)
+        @application = application
+        @key = key
+      end
+
+      def redirect_url(locale: 'fr', timestamp:, user_attributes:)
+        enforce_sso_attributes(user_attributes)
+
+        params = sign_params(user_attributes.merge(timestamp: timestamp))
+        encoded_params = URI.encode_www_form(params)
+
+        "#{BASE_URL}/p/#{locale}/#{application}/sso?#{encoded_params}"
+      end
+
+      private
+
+      attr_reader :application, :key
+
+      def enforce_sso_attributes(attributes)
+        required = %i(email external_id firstname lastname)
+        missing = required.reject { |key| attributes[key] }
+
+        raise(
+          ArgumentError,
+          "Missing mandatory attributes for SSO : #{missing.join(', ')}"
+        ) if missing.any?
+      end
+
+      def sign_params(params)
+        # Custom ordering
+        tosign = params.values_at(
+          :email,
+          :firstname,
+          :lastname,
+          :external_id,
+          :"group[]",
+          :user_type,
+          :timestamp
+        ).compact.join + key
+
+        params.merge(hash: Digest::MD5.hexdigest(tosign))
+      end
+
+    end
+  end
+end

data/lib/doyoubuzz/showcase/version.rb

@@ -1,3 +1,3 @@
 module Doyoubuzz
-  VERSION = "0.2.0"
+  VERSION = '0.3.0'
 end

data/spec/showcase/sso_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+require 'doyoubuzz/showcase/sso'
+
+RSpec.describe Doyoubuzz::Showcase::SSO, type: :type do
+  let(:application) { 'example_application' }
+  let(:key) { 'vpsdihgfdso' }
+
+  subject { described_class.new(application, key) }
+
+  describe '#new' do
+    it 'requires an application name and an sso key' do
+      expect { described_class.new }.to raise_error(ArgumentError)
+      expect { described_class.new(application, key) }.not_to raise_error
+    end
+  end
+
+  describe '#redirect_url' do
+    let(:timestamp) { 1370534334 }
+    let(:user_attributes) do
+      {
+        email: 'email@host.tld',
+        firstname: 'John',
+        lastname: 'Doe',
+        external_id: 12345
+      }
+    end
+
+    it 'verifies all the mandatory user attributes are given' do
+      user_attributes.keys.each do |mandatory_key|
+        incomplete_attributes = user_attributes.reject { |k, _| k == mandatory_key }
+
+        expect do
+          subject.redirect_url(
+            timestamp: timestamp,
+            user_attributes: incomplete_attributes
+          )
+        end.to raise_error(
+          ArgumentError,
+          "Missing mandatory attributes for SSO : #{mandatory_key}"
+        )
+      end
+    end
+
+    it 'computes the right url' do
+      expect(
+        subject.redirect_url(
+          timestamp: timestamp,
+          user_attributes: user_attributes
+        )
+      ).to eq('http://showcase.doyoubuzz.com/p/fr/example_application/sso?email=email%40host.tld&firstname=John&lastname=Doe&external_id=12345&timestamp=1370534334&hash=94a0adad0a9bafdf511326cae3bf7626')
+    end
+
+    it 'handles locales properly' do
+      expect(
+        subject.redirect_url(
+          locale: 'en',
+          timestamp: timestamp,
+          user_attributes: user_attributes
+        )
+      ).to eq('http://showcase.doyoubuzz.com/p/en/example_application/sso?email=email%40host.tld&firstname=John&lastname=Doe&external_id=12345&timestamp=1370534334&hash=94a0adad0a9bafdf511326cae3bf7626')
+    end
+  end
+end

data/spec/showcase_spec.rb

@@ -2,115 +2,99 @@ require 'spec_helper'
 
 require 'doyoubuzz/showcase'
 
-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) }
+RSpec.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
-      expect{ Doyoubuzz::Showcase.new }.to raise_error ArgumentError
+    it 'requires an api key and secret key' do
+      expect { Doyoubuzz::Showcase.new }.to raise_error ArgumentError
 
-      expect{ Doyoubuzz::Showcase.new(api_key, api_secret) }.to_not raise_error
+      expect { Doyoubuzz::Showcase.new(api_key, api_secret) }.to_not raise_error
     end
   end
 
   describe '#call' do
-    let(:arguments){ {:foo => 'bar', :zab => 'baz'} }
-    let(:timestamp){ 1370534334 }
+    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
+    # The timestamp is important in the request generation and the VCR
+    # handling. Here it is set at a fixed date
+    before do
       time = Time.at(timestamp)
       allow(Time).to receive(:now).and_return time
     end
 
-    it "should generate a valid signed api call" do
-      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"}})
+    it 'generates a valid signed api call' do
+      # We only want to check the sent parameters here
+      allow(showcase).to receive(:process_response)
+      expect(showcase.class).to 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
-      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"}})
+    it 'puts the parameters in the body for PUT requests' do
+      # We only want to check the sent parameters here
+      allow(showcase).to receive(:process_response)
+      expect(showcase.class).to receive(:put).with(
+        '/path',
+        query: {
+          apikey: 'an_api_key',
+          timestamp: timestamp,
+          hash: '11a68a1bb9e23c681438efb714c9ad4d'
+        },
+        body: { foo: 'bar', zab: 'baz' }
+      )
 
       showcase.put('/path', arguments)
     end
 
-    it "should handle HTTP verbs" do
-      expect(showcase).to respond_to :get
-      expect(showcase).to respond_to :post
-      expect(showcase).to respond_to :put
-      expect(showcase).to respond_to :delete
+    it 'handles HTTP verbs' do
+      expect(showcase).to respond_to(:get)
+      expect(showcase).to respond_to(:post)
+      expect(showcase).to respond_to(:put)
+      expect(showcase).to respond_to(:delete)
     end
 
-    it "should return an explorable hash" do
-      VCR.use_cassette("good_call") do
+    it 'returns an explorable hash' do
+      VCR.use_cassette('good_call') do
         res = showcase.get('/users')
 
-        res.keys.should == ["users", "total", "next"]
-        res["users"]["items"].first.keys.should == ["username", "email", "firstname", "lastname", "id"]
-        res.users.items.first.username.should == "lvrmterjwea"
+        expect(res.keys).to eq(%w(users total next))
+        expect(res['users']['items'].first.keys).
+          to eq(%w(username email firstname lastname id))
+        expect(res.users.items.first.username).
+          to eq('lvrmterjwea')
       end
     end
 
-
-    it "should handle array responses" do
-      VCR.use_cassette("good_call") do
+    it 'handles array responses' do
+      VCR.use_cassette('good_call') do
         res = showcase.get('/tags')
 
-        res.should be_a Array
-        res.first.should be_a Hashie::Mash
+        expect(res).to be_an(Array)
+        expect(res.first).to be_a(Hashie::Mash)
       end
     end
 
-
-    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(Doyoubuzz::Showcase::Error)
-          error.status.should == 403
-          error.message.should == "Forbidden"
-          error.inspect.should == "#<Doyoubuzz::Showcase::Error 403: Forbidden>"
+    it 'raises an exception on a failed call' do
+      VCR.use_cassette('failed_call') do
+        expect { showcase.get('/users') }.to raise_error do |error|
+          expect(error).to be_a(Doyoubuzz::Showcase::Error)
+          expect(error.status).to eq(403)
+          expect(error.message).to eq('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=94a0adad0a9bafdf511326cae3bf7626'
-    end
-
-  end
-
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doyoubuzz-showcase
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - David RUYER
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 3.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 3.5.0
 description: Wrapper around the DoYouBuzz showcase API
 email:
 - david.ruyer@gmail.com
@@ -85,9 +85,11 @@ files:
 - doyoubuzz-showcase.gemspec
 - lib/doyoubuzz/showcase.rb
 - lib/doyoubuzz/showcase/error.rb
+- lib/doyoubuzz/showcase/sso.rb
 - lib/doyoubuzz/showcase/version.rb
 - spec/fixtures/vcr_cassettes/failed_call.yml
 - spec/fixtures/vcr_cassettes/good_call.yml
+- spec/showcase/sso_spec.rb
 - spec/showcase_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -110,13 +112,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Wrapper around the DoYouBuzz showcase API
 test_files:
 - spec/fixtures/vcr_cassettes/failed_call.yml
 - spec/fixtures/vcr_cassettes/good_call.yml
+- spec/showcase/sso_spec.rb
 - spec/showcase_spec.rb
 - spec/spec_helper.rb
-has_rdoc: