expressly 2.0.32.rc1 → 2.0.34.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 765092a460c3705f8841d13a0a39acfaa5d69304
-  data.tar.gz: 274eed1b540c881777a709ad7c26267d40630dee
+  metadata.gz: b50498abdf3764473491a48322e57379c2b5051a
+  data.tar.gz: 13b7a6af1a7a920477bdcbb0cec772f8b287746f
 SHA512:
-  metadata.gz: 8c56a2753464a13dcd47c858b99fa2cbac90554a366a8da766af141a26bc2703b75f8c8a3e1f8bc2a27d22c31c84275721b0a96941da2cb138a669bb81bb2dc2
-  data.tar.gz: 493cbaa6101ddfda59fb10469affca648d59ca74afe0dea7645208fed21a5cf18ab3c63c32369f2ad0e8ab2486e2c21c2269b294d2d2d121c0c05976fa68719a
+  metadata.gz: 05258c1b5f1dddbed4e841377dc7fb8dc32501957f4d03df8c342c51f8685f454bfd8e8ebd60224bda4686f47b7c22a6c9aa2aa4a991c53d84d20eed3335fe00
+  data.tar.gz: ea6d6cb1833c097766399e5c54714f9dc2b087de448c0c6076e289765539b23e42b99c476f214914a79abf2b36fa30a86003b3e8aa4a7a33f14356329766e96f

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.3
+  - 2.1.6
+  - 2.2.2

data/Gemfile

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

data/Gemfile.lock

@@ -1,6 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    awesome_print (1.2.0)
     celluloid (0.15.2)
       timers (~> 1.1.0)
     coderay (1.1.0)
@@ -17,7 +18,6 @@ GEM
     guard-rspec (4.0.4)
       guard (>= 2.1.1)
       rspec (~> 2.14)
-    httpclient (2.7.0.1)
     json (1.8.1)
     listen (2.2.0)
       celluloid (>= 0.15.2)
@@ -29,6 +29,7 @@ GEM
       coderay (~> 1.0)
       method_source (~> 0.8)
       slop (~> 3.4)
+    rake (10.4.2)
     rb-fsevent (0.9.3)
     rb-inotify (0.9.2)
       ffi (>= 0.5.0)
@@ -45,21 +46,18 @@ GEM
     slop (3.4.7)
     thor (0.18.1)
     timers (1.1.0)
-    tzinfo (0.3.37)
-    wdm (0.1.1)
 
 PLATFORMS
   ruby
   x64-mingw32
 
 DEPENDENCIES
+  awesome_print (~> 1.2.0)
   bundler
   guard
   guard-rspec
-  httpclient
+  rake
   rdoc (~> 3.12)
-  tzinfo (= 0.3.37)
-  wdm (>= 0.1.0)
 
 BUNDLED WITH
    1.10.6

data/README.rdoc

@@ -1,5 +1,27 @@
+{<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.
 

data/Rakefile

@@ -1,2 +1,7 @@
 require 'bundler'
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs"
+task :default do
+  exec 'rspec spec'
+end

data/lib/expressly.rb

@@ -1,3 +1,5 @@
+require 'logger'
+
 module Expressly
   @@logger = Logger.new(STDERR)
   @@logger.level= Logger::Severity::INFO
@@ -12,16 +14,37 @@ module Expressly
   def self.default_configuration?() 
     !@@default_configuration.nil?
   end
-  
-  def self.default_configuration=(default_configuration) 
+
+  ##
+  # Set the default configuration. This is how the ApiController so you must call this with your configuration .
+  #
+  # === Args
+  #
+  # * +default_configuration+ - an Expressly::Configuration instance
+  #
+  def self.default_configuration=(default_configuration)
     @@default_configuration = default_configuration 
   end
-  
+
+  ##
+  # The configuration object for boot strapping the Expressly plugin engine.
+  #
   class Configuration
     attr_reader :api_key, 
       :merchant_plugin_provider, :merchant_plugin_endpoint, :merchant_metadata,
       :expressly_provider, :expressly_endpoint
-    
+
+    ##
+    # Constructor arguments
+    #
+    # === Args
+    #
+    # * +api_key+ - your Expressly API key
+    # * +merchant_plugin_provider+ - your Expressly::MerchantPluginProvider implementation
+    # * +merchant_plugin_endpoint+ - the http endpoint of your store, i.e. the bit that comes before /expressly/api/...
+    # * +merchant_metadata+ - a hash of metadata that may be sent to the server on a customer export
+    # * +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
       @merchant_plugin_provider = merchant_plugin_provider
@@ -33,8 +56,6 @@ module Expressly
   end
 end
 
-require 'logger'
-
 require 'expressly/version'
 require 'expressly/util'
 require 'expressly/domain'

data/lib/expressly/plugin_provider.rb

@@ -1,7 +1,9 @@
 module Expressly
   ##
   # This "interface" should be "implemented" by you and provided to the Expressly::Configuration constructor. 
-  # It is the bridge between the expressly domain and your platform.
+  # It is the bridge between the expressly domain and your platform. The Expressly::ApiController is responsible
+  # for marshalling and routing requests to your platform and directing calls to your specific provider implementation.
+  #
   #
   class MerchantPluginProvider
     include AbstractInterface
@@ -11,46 +13,156 @@ module Expressly
     # and been directed to your shop. You are required to make a call to retrieve the expressly popup html
     # and embed it on the landing page of your choice.
     #
+    # The typical flow would be:
+    #
+    # 1. customer clicks a promotion link to https://yourshop.com/expressly/api/:campaign_customer_uuid
+    # 2. ApiController call popup_handler with itself as the first parameter and the uuid as the second parameter
+    # 3. The handler should through a mechanism of their choice should display an appropriate page on their site and embed the Expressly popup HTML
+    #
+    # The mechanics of how to acheive step 3 is up to the implementer. The Expressly popup HTML is retrieved with the following call:
+    # Expressly::default_configuration.expressly_provider.fetch_migration_confirmation_html(campaign_customer_uuid)
+    #
+    # === Args
+    #
+    # * +controller+ - an ApplicationController instance
+    # * +campaign_customer_uuid+ - the Expressly uuid identifying the customer to be migrated
+    #
+    # === Return
+    #
+    # N/A
+    #
     def popup_handler(controller, campaign_customer_uuid)
       MerchantPluginProvider.api_not_implemented(self)
     end
 
+    ##
+    # The customer register is the first step of the migration process after they have confirmed that they want to proceed.
+    # You should register the customer on you system when you receive this call. You should treat this as a new customer,
+    # i.e. send them a welcome email etc.
+    #
+    # === Args
+    #
+    # * +primary_email+ - the new customer's identifying e-mail address (note that the emails within the customer object may only contain alternate addresses)
+    # * +customer+ - an Expressly::Customer instance with the data of the customer to import
+    #
+    # === Return
+    #
+    # The reference you would like to use to further identify the customer within the remaining migration calls. This
+    # can be anything that works for you from the email address, the database identifier, to your internal customer object.
+    #
     def customer_register(primary_email, customer)
       MerchantPluginProvider.api_not_implemented(self)
     end
 
+    ##
+    # You should execute a password reset on behalf of the user and send them an email so that they can reset their
+    # password.
+    #
+    # === Args
+    #
+    # * +customer_reference+ - the reference you returned in the customer_register call
+    #
+    # === Return
+    #
+    # N/A
+    #
     def customer_send_password_reset_email(customer_reference)
       MerchantPluginProvider.api_not_implemented(self)
     end
 
+    ##
+    # You should update the customer's cart to include the coupon and/or product if either or both are present.
+    #
+    # === Args
+    #
+    # * +customer_reference+ - the reference you returned in the customer_register call
+    # * +cart+ - an instance of Expressly::Cart with the details of how to update the cart with
+    #
+    # === Return
+    #
+    # N/A
+    #
     def customer_update_cart(customer_reference, cart)
       MerchantPluginProvider.api_not_implemented(self)
     end
 
+    ##
+    # You should log the user in on their current session.
+    #
+    # === Args
+    #
+    # * +customer_reference+ - the reference you returned in the customer_register call
+    #
+    # === Return
+    #
+    # N/A
+    #
     def customer_login(customer_reference)
       MerchantPluginProvider.api_not_implemented(self)
     end
 
+    ##
+    # Once the customer is migrated they will need to be re-directed to the most appropriate location on your site.
+    # This could be the home page or the checkout.
+    #
+    # === Args
+    #
+    # * +success+ - if true then the customer was successfully migrated, if false then it failed and customer_reference will be nil
+    # * +customer_reference+ - the reference you returned in the customer_register call unless the migration failed, in which case it will be nil
+    #
+    # === Return
+    #
+    # N/A
+    #
     def customer_migrated_redirect_url(success, customer_reference)
       MerchantPluginProvider.api_not_implemented(self)
     end
 
     ##
-    # Some documentation on the check_customer_statuses method
-    # return Expressly::Customer
+    # The provider should respond to this call by populating an Expressly::Customer instance with the details of
+    # the customer that matches the email address passed to it.
+    #
+    # === Args
+    #
+    # * +email+ - the email address of the customer to be exported
+    #
+    # === Return
+    #
+    # An instance of Expressly::Customer to be exported. It should attempt to fill in as many fields as possible.
+    #
     def get_customer(email)
       MerchantPluginProvider.api_not_implemented(self)
     end
 
     ##
-    # Some documentation on the check_customer_statuses method
+    # Check the statuses of the email addresses supplied. Given the list the implementer should check for the
+    # existence of the email addresses in their system and for those that exist should return an
+    # Expressly::CustomerStatuses instance.
+    #
+    # === Args
+    #
+    # * +email_list+ - a list of the emails to check.
+    #
+    # === Return
+    #
+    # An instance of Expressly::CustomerStatuses.
+    #
     def check_customer_statuses(email_list)
       MerchantPluginProvider.api_not_implemented(self)
     end
 
     ##
-    # Some documentation on the get_order_details method
-    # Returns ...
+    # Retrieve the invoices and orders in a given time frame for the supplied email addresses. Each entry consists
+    # of the email address, a from date (inclusive) and a to date (exclusive)
+    #
+    # === Args
+    #
+    # * +customer_invoice_request_list+ - a list of Expressly::CustomerInvoiceRequest objects.
+    #
+    # === Return
+    #
+    # A list of Expressly::CustomerInvoice objects for all the customers referenced in the request.
+    #
     def get_customer_invoices(customer_invoice_request_list)
       MerchantPluginProvider.api_not_implemented(self)
     end

data/lib/expressly/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: expressly
 version: !ruby/object:Gem::Version
-  version: 2.0.32.rc1
+  version: 2.0.34.rc1
 platform: ruby
 authors:
 - Marc G. Smith
@@ -78,6 +78,7 @@ files:
 - ".document"
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - Guardfile