expressly 2.0.34.rc1 → 2.0.35.rc1

data/.travis.yml

@@ -2,3 +2,7 @@ rvm:
   - 1.9.3
   - 2.1.6
   - 2.2.2
+
+addons:
+  code_climate:
+    repo_token: 4b7cb0837c0bcb22501262f1c463f02f189dbb510001c68e2e498db0e80f24bb

data/Gemfile

@@ -3,10 +3,11 @@ gem 'rake'
 
 group :development do
   require 'rbconfig'
-  #gem 'fakeweb'
+  gem "fakeweb", "~> 1.3"
   gem 'awesome_print', '~> 1.2.0'
   gem 'guard-rspec'
   gem 'guard'
   gem "rdoc", "~> 3.12"
+  gem "codeclimate-test-reporter", group: :test, require: nil
   #gem 'wdm', '>= 0.1.0' if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
 end

data/Gemfile.lock

@@ -4,8 +4,12 @@ GEM
     awesome_print (1.2.0)
     celluloid (0.15.2)
       timers (~> 1.1.0)
+    codeclimate-test-reporter (0.4.8)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.0)
     diff-lcs (1.2.5)
+    docile (1.1.5)
+    fakeweb (1.3.0)
     ffi (1.9.3)
     ffi (1.9.3-x64-mingw32)
     formatador (0.2.4)
@@ -43,6 +47,11 @@ GEM
     rspec-expectations (2.14.4)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.4)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
     slop (3.4.7)
     thor (0.18.1)
     timers (1.1.0)
@@ -54,6 +63,8 @@ PLATFORMS
 DEPENDENCIES
   awesome_print (~> 1.2.0)
   bundler
+  codeclimate-test-reporter
+  fakeweb (~> 1.3)
   guard
   guard-rspec
   rake

data/README.rdoc

@@ -1,27 +1,35 @@
-{<img src="https://buyexpressly.com/assets/img/expressly-logo-sm-gray.png" alt="Expressly" />}[https://buyexpressly.com]
-{<img src="https://badge.fury.io/rb/expressly.svg" alt="Gem Version" />}[https://badge.fury.io/rb/expressly]
-{<img src="https://api.travis-ci.org/expressly/expressly-plugin-sdk-ruby-core.png" alt="Build Status" />}[https://api.travis-ci.org/expressly/expressly-plugin-sdk-ruby-core]
-= Expressly Plug-in Ruby SDK
-
-The Expressly Ruby SDK provides as much of the heavy-lifting of the Expressly Network API to help developers wishing to
-integrate their rails e-commerce platform with the {Expressly network}[https://buyexpressly.com].
-
-== Getting Started
-
-gemfile::
-   gem 'expressly', '~> 2.0'
-
-install::
-   gem install expressly --pre
-
-You can find a Rails reference implementation {here}[https://github.com/expressly/expressly-plugin-rails-reference-implementation]
-to help you get started.
-
-== More Info
-
-Further resources can be found on the {Expressly developer portal}[http://developer.buyexpressly.com].
-
-== License
-
-Copyright (c) 2015 Expressly. See LICENSE.txt for further details.
-
+{<img src="https://buyexpressly.com/assets/img/expressly-logo-sm-gray.png" alt="Expressly" />}[https://buyexpressly.com]
+
+= Expressly Plug-in Ruby SDK
+
+{<img src="https://badge.fury.io/rb/expressly.svg" alt="Gem Version" />}[https://badge.fury.io/rb/expressly]
+{<img src="https://api.travis-ci.org/expressly/expressly-plugin-sdk-ruby-core.png" alt="Build Status" />}[https://travis-ci.org/expressly/expressly-plugin-sdk-ruby-core]
+{<img src="https://codeclimate.com/github/expressly/expressly-plugin-sdk-ruby-core/badges/gpa.svg" />}[https://codeclimate.com/github/expressly/expressly-plugin-sdk-ruby-core]
+{<img src="https://codeclimate.com/github/expressly/expressly-plugin-sdk-ruby-core/coverage.png" />}[https://codeclimate.com/github/expressly/expressly-plugin-sdk-ruby-core/coverage]
+
+The Expressly Ruby SDK provides as much of the heavy-lifting of the Expressly Network API to help developers wishing to
+integrate their rails e-commerce platform with the {Expressly network}[https://buyexpressly.com].
+
+== Getting Started
+
+gemfile::
+   gem 'expressly', '~> 2.0'
+
+install::
+   gem install expressly --pre
+
+You can find a Rails reference implementation {here}[https://github.com/expressly/expressly-plugin-rails-reference-implementation]
+to help you get started.
+
+== More Info
+
+Further resources can be found on the {Expressly developer portal}[http://developer.buyexpressly.com].
+
+== License
+
+Copyright (c) 2015 Expressly. See LICENSE.txt for further details.
+
+== One-click customer acquisition
+
+Expressly helps merchants grow by attracting new quality visitors from other online shops where people already buy,
+while making it extremely convenient for them to convert to the new shop.

data/app/controllers/expressly/api_controller.rb

@@ -33,7 +33,6 @@ module Expressly
     end
 
     def display_popup
-      campaign_customer_uuid = params[:campaign_customer_uuid]
       provider.popup_handler(self, params[:campaign_customer_uuid])
     end
 
@@ -50,7 +49,7 @@ module Expressly
 
         begin
           config.expressly_provider.confirm_migration_success?(campaign_customer_uuid)
-        rescue Exception => e
+        rescue StandardError => e
           Expressly::logger.warn(self) {
             "couldn't finalise migration campaign_customer_uuid=[#{campaign_customer_uuid}], email=[#{import.primary_email}], error=[#{e.message}]"
           }
@@ -62,9 +61,9 @@ module Expressly
     end
 
     def authenticate
-      partitionedApiKey = config.api_key.partition(':')
+      partitioned_api_key = config.api_key.partition(':')
       authenticate_or_request_with_http_basic('expressly') do |username, password|
-        username == partitionedApiKey[0] && password == partitionedApiKey[2]
+        username == partitioned_api_key[0] && password == partitioned_api_key[2]
       end
     end
 

data/expressly.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<guard-rspec>, ["~> 0"])
   s.add_development_dependency(%q<guard>, ["~> 0"])
   s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+  s.add_development_dependency(%q<fakeweb>, ["~> 1.3"])
 end

data/lib/expressly.rb

@@ -1,4 +1,5 @@
 require 'logger'
+require 'base64'
 
 module Expressly
   @@logger = Logger.new(STDERR)
@@ -6,13 +7,14 @@ module Expressly
   
   def self.logger() @@logger end
   def self.logger=(logger) @@logger = logger end
-    
+
+  @@default_configuration = nil
   def self.default_configuration() 
     @@default_configuration 
   end
   
   def self.default_configuration?() 
-    !@@default_configuration.nil?
+    @@default_configuration != nil
   end
 
   ##
@@ -46,7 +48,7 @@ module Expressly
     # * +expressly_endpoint+ - the Expressly server endpoint. Defaults to the Expressly production service.
     #
     def initialize(api_key, merchant_plugin_provider, merchant_plugin_endpoint, merchant_metadata = {}, expressly_endpoint = 'https://prod.expresslyapp.com/api')
-      @api_key = api_key
+      @api_key = api_key.include?(":") ? api_key : Base64.strict_decode64(api_key)
       @merchant_plugin_provider = merchant_plugin_provider
       @merchant_plugin_endpoint = merchant_plugin_endpoint
       @expressly_endpoint = expressly_endpoint

data/lib/expressly/api.rb

@@ -2,67 +2,67 @@ module Expressly
   class Api
     
     def initialize(apikey, endpoint = 'https://prod.expresslyapp.com/api')
-      partitionedApiKey = apikey.partition(':')
-      @merchantUuid = partitionedApiKey[0]
-      @secretKey = partitionedApiKey[2]
+      partitioned_api_key = apikey.partition(':')
+      @merchant_uuid = partitioned_api_key[0]
+      @secret_key = partitioned_api_key[2]
       @endpoint = endpoint
     end
 
     def ping?
       response = execute('/v1/merchant/ping', 'GET')
-      return JSON.parse(response.body)['success']
+      JSON.parse(response.body)['success']
     end
 
-    def install(baseUrl)
-      apiKey = Base64.strict_encode64("#{@merchantUuid}:#{@secretKey}")
-      response = execute(
+    def install(base_url)
+      api_key = Base64.strict_encode64("#{@merchant_uuid}:#{@secret_key}")
+      execute(
         '/v2/plugin/merchant', 
         'POST', 
-        "{\"apiBaseUrl\":\"#{baseUrl}\", \"apiKey\":\"#{apiKey}\"}")
+        "{\"apiBaseUrl\":\"#{base_url}\", \"apiKey\":\"#{api_key}\"}")
     end
 
     def uninstall?
       response = execute(
-        "/v2/plugin/merchant/#{@merchantUuid}", 
+        "/v2/plugin/merchant/#{@merchant_uuid}", 
         'DELETE')
-      return JSON.parse(response.body)['success']
+      JSON.parse(response.body)['success']
     end
 
     def fetch_migration_confirmation_html(campaign_customer_uuid)
       response = execute(
         "/v2/migration/#{campaign_customer_uuid}", 
         'GET')
-      return response.body
+      response.body
     end
 
     def fetch_customer_data(campaign_customer_uuid)
       response = execute(
         "/v2/migration/#{campaign_customer_uuid}/user", 
         'GET')
-      return CustomerImport.from_json(JSON.parse(response.body))
+      CustomerImport.from_json(JSON.parse(response.body))
     end
 
     def confirm_migration_success?(campaign_customer_uuid)
       response = execute(
         "/v2/migration/#{campaign_customer_uuid}/success", 
         'POST')
-      return JSON.parse(response.body)['success']
+      JSON.parse(response.body)['success']
     end
 
-    def execute(methodUri, httpVerb, body = nil)
-      uri = URI.parse("#{@endpoint}#{methodUri}")
+    def execute(method_uri, http_verb, body = nil)
+      uri = URI.parse("#{@endpoint}#{method_uri}")
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = @endpoint.start_with?('https')
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
 
       request =
-        if httpVerb == 'GET' then Net::HTTP::Get.new(uri.request_uri)
-        elsif httpVerb == 'POST' then Net::HTTP::Post.new(uri.request_uri)
-        elsif httpVerb == 'DELETE' then Net::HTTP::Delete.new(uri.request_uri)
-        else raise "unexpected http verb [#{httpVerb}]"
+        if http_verb == 'GET' then Net::HTTP::Get.new(uri.request_uri)
+        elsif http_verb == 'POST' then Net::HTTP::Post.new(uri.request_uri)
+        elsif http_verb == 'DELETE' then Net::HTTP::Delete.new(uri.request_uri)
+        else raise "unexpected http verb [#{http_verb}]"
         end
 
-      request.basic_auth(@merchantUuid, @secretKey)
+      request.basic_auth(@merchant_uuid, @secret_key)
       if body != nil then
         request["Content-Type"] = 'application/json'
         request.body = body
@@ -74,16 +74,14 @@ module Expressly
         handle_error(response)
       end
 
-      return response
+      response
     end
 
     def handle_error(response)
       is_json = response.content_type == "application/json"
       body = is_json ? JSON.parse(response.body) : response.body
 
-      raise (if is_json && !body['id'].nil? then
-        ExpresslyError.new(body) else
-        HttpError.new(response)  end)
+      raise (if is_json && !body['id'].nil? then ExpresslyError.new(body) else HttpError.new(response) end)
     end
 
     private :execute, :handle_error

data/lib/expressly/domain.rb

@@ -31,7 +31,7 @@ module Expressly
       ObjectHelper.equals(self,object)
     end
 
-    def to_json(state = nil)
+    def to_json(_state = nil)
       JSON.generate({
         :meta => @metadata,
         :data => {
@@ -126,7 +126,7 @@ module Expressly
       datetime.nil? ? nil : DateTime.parse(datetime)
     end
 
-    def to_json(state = nil)
+    def to_json(_state = nil)
       JSON.generate({
         :firstName => @first_name,
         :lastName => @last_name,
@@ -194,7 +194,7 @@ module Expressly
       return list
     end
 
-    def to_json(state = nil)
+    def to_json(_state = nil)
       JSON.generate({
         :firstName => @first_name,
         :lastName => @last_name,
@@ -253,7 +253,7 @@ module Expressly
       return list
     end
 
-    def to_json(state = nil)
+    def to_json(_state = nil)
       JSON.generate({
         :type => @type.to_s,
         :number => @number,
@@ -298,7 +298,7 @@ module Expressly
       return list
     end
 
-    def to_json(state = nil)
+    def to_json(_state = nil)
       JSON.generate({
         :email => @email,
         :alias => @alias
@@ -339,7 +339,7 @@ module Expressly
       return list
     end
 
-    def to_json(state = nil)
+    def to_json(_state = nil)
       JSON.generate({
         :field => @type.to_s,
         :value => @identity
@@ -432,7 +432,7 @@ module Expressly
       @tax += order.tax.to_f
     end
 
-    def to_json(state = nil)
+    def to_json(_state = nil)
       JSON.generate(json_attribute_map)
     end
 
@@ -464,7 +464,7 @@ module Expressly
       @order_date = if order_date.is_a? Date then order_date else Date.parse(order_date) end
     end
 
-    def to_json(state = nil)
+    def to_json(_state = nil)
       JSON.generate({
         :id => @order_id,
         :date => @order_date,

data/lib/expressly/util.rb

@@ -66,12 +66,11 @@ module Expressly
        
     end
     
-    protected
+
     def Enumeration.add_item(key,value)
       @hash ||= {}
       @hash[key]=value
     end
-    
   end
 
   module AbstractInterface

data/lib/expressly/version.rb

@@ -2,7 +2,7 @@ module Expressly
   module Version
     MAJOR = 2
     MINOR = 0
-    PATCH = 34
+    PATCH = 35
     BUILD = 'rc1'
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/spec/expressly/api_spec.rb

@@ -0,0 +1,117 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module Expressly
+  merchant_uuid = '61c8c55e-9365-11e5-ac6c-281878baaac8'
+  campaign_customer_uuid = '140d190c-b73c-4e59-aa01-c838c4ddde9d'
+  api_key = '61c8c55e-9365-11e5-ac6c-281878baaac8:d62e517165bf86562d7fe0dbf8ac2076'
+  api_url = 'http://localhost:8080/api'
+  api = Expressly::Api.new(api_key, api_url)
+  #FakeWeb.allow_net_connect = false
+
+  describe "Api" do
+
+    it "can ping" do
+      FakeWeb.register_uri(:get, "http://#{api_key}@localhost:8080/api/v1/merchant/ping",
+                           :body => '{"success":true,"msg":"61c8c55e-9365-11e5-ac6c-281878baaac8"}')
+      api.ping?.should == true
+    end
+
+    it "it can install" do
+      FakeWeb.register_uri(:post, "http://#{api_key}@localhost:8080/api/v2/plugin/merchant",
+                           :status => ["204", "No Content"])
+      api.install("http://localhost:3000")
+    end
+
+    it "it can uninstall" do
+      FakeWeb.register_uri(:delete, "http://#{api_key}@localhost:8080/api/v2/plugin/merchant/#{merchant_uuid}",
+                           :body => '{"success":true,"msg":"Merchant uninstalled"}')
+      api.uninstall?.should == true
+    end
+
+    it "it can fetch poup html" do
+      FakeWeb.register_uri(:get, "http://#{api_key}@localhost:8080/api/v2/migration/#{campaign_customer_uuid}",
+                           :body => '<b>pop</b>')
+      response = api.fetch_migration_confirmation_html(campaign_customer_uuid)
+      response.should == '<b>pop</b>'
+    end
+
+    it "it can fetch customer data" do
+      FakeWeb.register_uri(:get, "http://#{api_key}@localhost:8080/api/v2/migration/#{campaign_customer_uuid}/user",
+                           :body => '{ "migration":{"meta":{"sender":"2"},"data":{"email":"m@9ls.com","customerData":' +
+                               '{"firstName":"Marc","lastName":"Smith","gender":"M","billingAddress":0,"shippingAddress":0,' +
+                               '"dateUpdated":"2015-11-25T13:21:04.000Z","numberOrdered":0,' +
+                               '"onlinePresence":[{"field":"twitter","value":"mgsmith57"}],"emails":[{"email":"someone@test.com"}],' +
+                               '"phones":[{"type":"L","number":"020 7946 0975","countryCode":44}],' +
+                               '"addresses":[{"firstName":"Marc","lastName":"SMith","address1":"61 Wellfield Road","city":"Roath","zip":"CF24 3DG","phone":0,"stateProvince":"Cardiff","country":"GB"}]}}},' +
+                               '"cart":{"couponCode":"coupon","productId":"product"}}')
+      customer_import = api.fetch_customer_data(campaign_customer_uuid)
+      customer_import.metadata.should == {"sender" => "2"}
+      customer_import.cart.coupon_code.should == 'coupon'
+      customer_import.cart.product_id.should == 'product'
+      customer_import.primary_email.should == 'm@9ls.com'
+      customer_import.customer.first_name.should == 'Marc'
+      customer_import.customer.last_name.should == 'Smith'
+      customer_import.customer.gender.should == Gender::Male
+      customer_import.customer.billing_address_index.should == 0
+      customer_import.customer.shipping_address_index.should == 0
+      customer_import.customer.last_updated.should == DateTime.parse('2015-11-25T13:21:04+00:00')
+      customer_import.customer.online_identity_list[0].type.should == OnlineIdentityType::Twitter
+      customer_import.customer.online_identity_list[0].identity.should == 'mgsmith57'
+      customer_import.customer.email_list[0].email.should == 'someone@test.com'
+      customer_import.customer.phone_list[0].number.should == '020 7946 0975'
+      customer_import.customer.phone_list[0].type.should == PhoneType::Landline
+      customer_import.customer.phone_list[0].country_code.should == 44
+      customer_import.customer.address_list[0].first_name.should == 'Marc'
+      customer_import.customer.address_list[0].last_name.should == 'SMith'
+      customer_import.customer.address_list[0].address_1.should == '61 Wellfield Road'
+      customer_import.customer.address_list[0].city.should == 'Roath'
+      customer_import.customer.address_list[0].zip.should == 'CF24 3DG'
+      customer_import.customer.address_list[0].phone_index.should == 0
+      customer_import.customer.address_list[0].state_province.should == 'Cardiff'
+      customer_import.customer.address_list[0].country.should == 'GB'
+    end
+
+    it "it can report the migration was successful" do
+      FakeWeb.register_uri(:post, "http://#{api_key}@localhost:8080/api/v2/migration/#{campaign_customer_uuid}/success",
+                           :body => '{"success":true,"msg":"User registered as migrated"}')
+      response = api.confirm_migration_success?(campaign_customer_uuid)
+      response.should == true
+    end
+
+    it "it can parse the expressly error payload" do
+      FakeWeb.register_uri(:get, "http://#{api_key}@localhost:8080/api/v1/merchant/ping",
+                           :status => ["400", "Bad Request"],
+                           :content_type => "application/json",
+                           :body => '{' +
+                               '"id":"tid",' +
+                               '"message":"Bad Request",' +
+                               '"code":"USER_ALREADY_MIGRATED",' +
+                               '"description":"ON NO",' +
+                               '"causes":["cause"],' +
+                               '"actions":["action"]}')
+      begin
+        api.ping?
+      rescue ExpresslyError => e
+        e.id.should == 'tid'
+        e.message.should == 'Bad Request'
+        e.code.should == 'USER_ALREADY_MIGRATED'
+        e.description.should == 'ON NO'
+        e.causes[0].should == 'cause'
+        e.actions[0].should == 'action'
+      end
+    end
+
+    it "if it can parse the expressly error payload it will throw an http error" do
+      FakeWeb.register_uri(:get, "http://#{api_key}@localhost:8080/api/v1/merchant/ping",
+                           :status => ["400", "Bad Request"],
+                           :body => 'WOW')
+      begin
+        api.ping?
+      rescue HttpError => e
+        e.code.should == "400"
+        e.body.should == 'WOW'
+      end
+    end
+  end
+end
+