lime_light_platform 1.0.0.17 → 1.0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b680b1a30f58c4717cd3275dc8b475c056412f86e3b3294c0546901a3d96207a
-  data.tar.gz: 2b61b89361918543dfb17f6d0b7df409e610d9b32fa803bbbeb45e175120ded2
+  metadata.gz: 5b390368b3a6891b9d338128b76ac534bf62ade8d537da6587403c4c36279664
+  data.tar.gz: a4ad66ec4dfeb2f61e7eb0f1df60c0995f4f7efd4a9bbbe6f2255464e39d2107
 SHA512:
-  metadata.gz: 9a8953d8e94d6dec3a7897553f9b33103fab9a2bdaf247f6c7d2115a35954e8ed07b466d4e9c2f7120954381aba6a1596d4b9a9682612ba042000e0b5857d306
-  data.tar.gz: c274fe64179362fcf30b102281053dd12b27a0b24d3e7a7fe8c765f330abe5ef8b7bf3b4e6e7e5f46f9232107216822bc548bf20c6e5ea6e0e2ff3df48aaa06a
+  metadata.gz: 3c788c89d45fe0fa20cf55901a158054d2d152203af3baeaff5cffd3115e5ae7c6893135cbfc00fd80933582e4eba157e552e2f147017227e53caff7e5878cb2
+  data.tar.gz: 33dc4d2d8411e0db57a6f9be4f172eb8c8b0c298920d69bbb1709c8886727be1b4ceac870c0cee93436ab10a236ed1a2f4043e69f1fa497082d9b571f4fa9351

data/lib/lime_light_platform.rb

@@ -4,6 +4,7 @@ require 'lime_light_platform/api_error'
 require 'lime_light_platform/app_base'
 require 'lime_light_platform/helpers/accessor'
 
+# @author Lime Light CRM Engineers
 class LimeLightPlatform < AppBase
   include Helpers::Accessor
 
@@ -14,6 +15,11 @@ class LimeLightPlatform < AppBase
               :api_password,
               :dev_subdirectory
 
+  # @param app_key [String] The CRM app key
+  # @param api_username [String] The CRM app key
+  # @param api_password [String] The CRM app key
+  # @param dev_subdirectory [String] Subdirectory for developer environments
+  # @param debug [Boolean] Increses the log level of API requests and responses
   def initialize app_key, api_username, api_password, dev_subdirectory='', debug=false
     super debug
 
@@ -39,10 +45,13 @@ class LimeLightPlatform < AppBase
     end
   end
 
+  # Retrieve billing model data for a specified billing model ID
+  # @param request [Hash] Request payload hash
   def billing_model_view request={}
     common_optional_param_perform_post base_call_params(__method__), ['offer_id', 'billing_model_id'], request
   end
 
+  # Return all active campaigns ina CRM instance
   def campaign_find_active
     response = default_response
     api_response = perform_api_call base_call_params(__method__)
@@ -70,18 +79,57 @@ class LimeLightPlatform < AppBase
     response
   end
 
+  # Retrieve campaign data for a specified campaign ID
+  # @param campaign_id [Integer] Campaign ID from CRM instance
   def campaign_view campaign_id
     common_entity_view_perform_post base_call_params(__method__), 'campaign_id', campaign_id
   end
 
+  # Validate a coupon based on promo code and other coupon parameters
+  # @param request [Hash] Request payload hash
+  def coupon_validate request={}
+    call_params = base_call_params __method__
+    call_params[:body] = {
+      'campaign_id' => get_if_exists('campaign_id', request, 0),
+      'shipping_id' => get_if_exists('shipping_id', request, 0),
+      'email' => get_if_exists('email', request),
+      'promo_code' => get_if_exists('promo_code', request),
+      'products' => get_if_exists('products', request)
+    }
+    common_perform_post call_params
+  end
+
+  # Retrieve customer data for a specified customer ID
+  # @param customer_id [Integer] Customer ID from CRM instance
   def customer_view customer_id
     common_entity_view_perform_post base_call_params(__method__), 'customer_id', customer_id
   end
 
+  # Retrieve gateway data for a specified gateway ID
+  # @param gateway_id [Integer] Gateway ID from CRM instance
   def gateway_view gateway_id
     common_entity_view_perform_post base_call_params(__method__), 'gateway_id', gateway_id
   end
 
+  # Retrieve alternative provider parameters (paypal, icepay)
+  # @param request [Hash] Request payload hash
+  def get_alternative_provider request={}
+    call_params = base_call_params __method__
+    call_params[:body] = {
+      'campaign_id' => get_if_exists('campaign_id', request, 0),
+      'alt_pay_type' => get_if_exists('alt_pay_type', request),
+      'return_url' => get_if_exists('return_url', request),
+      'cancel_url' => get_if_exists('cancel_url', request),
+      'amount' => get_if_exists('amount', request),
+      'shipping_id' => get_if_exists('shipping_id', request),
+      'bill_country' => get_if_exists('bill_country', request), # icepay only
+      'products' => get_if_exists('products', request)
+    }
+    common_perform_post call_params
+  end
+
+  # Create and process a new order
+  # @param request [Hash] Request payload hash
   def new_order request={}
     method_name = __method__.to_s
     call_params = base_call_params method_name.camelize
@@ -123,10 +171,14 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Retrieve offer data according to offer ID and/or campaign ID
+  # @param request [Hash] Request payload hash
   def offer_view request={}
     common_optional_param_perform_post base_call_params(__method__), ['offer_id', 'campaign_id'], request
   end
 
+  # Search for one or more order records according to criteria
+  # @param request [Hash] Request payload hash
   def order_find request={}
     call_params = base_call_params __method__
     date_times = default_date_times
@@ -155,6 +207,9 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Search for one or more order records according to criteria
+  #   Criteria is based on several updated statuses
+  # @param request [Hash] Request payload hash
   def order_find_updated request={}
     call_params = base_call_params __method__
     date_times = default_date_times
@@ -169,6 +224,7 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # @param request [Hash] Request payload hash
   def order_force_bill request={}
     call_params = base_call_params __method__
     call_params[:body] = {
@@ -186,12 +242,16 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Reprocess a declined order
+  # @param order_id [Integer] The order ID from CRM instance
   def order_reprocess order_id
     call_params = base_call_params __method__
     call_params[:body] = { 'order_id' => order_id }
     common_perform_post call_params
   end
 
+  # Update the recurring properties of an order on an active subscription
+  # @param request [Hash] Request payload hash
   def order_update_recurring request={}
     call_params = base_call_params __method__
     call_params[:body] = {
@@ -201,6 +261,8 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Updates an order record according to various criteria
+  # @param request [Hash] Request payload hash
   def order_update request={}
     call_params = base_call_params __method__
     call_params[:body] = { 'sync_all' => get_if_exists('sync_all', request, 0) }
@@ -254,26 +316,35 @@ class LimeLightPlatform < AppBase
     common_update_perform_post call_params, request, 'order_id', update_options
   end
 
+  #
+  # @param request [Hash] Request payload hash
   def order_view request={}
     call_params = base_call_params __method__
     call_params[:body] = { 'order_id' => get_if_exists('order_id', request, []) }
     common_perform_post call_params
   end
 
+  # @param request [Hash] Request payload hash
   def product_attribute_index request={}
     call_params = base_call_params __method__
     call_params[:body] = { 'product_id' => get_if_exists('product_id', request, []) }
     common_perform_post call_params
   end
 
+  # Return all product bundles in a CRM instance
   def product_bundle_index
     common_perform_post base_call_params(__method__)
   end
 
+  # Retrieve product bundle data for a specified product ID
+  #   This product must be a bundle
+  # @param product_id [Integer] Product ID from CRM instance
   def product_bundle_view product_id
     common_entity_view_perform_post base_call_params(__method__), 'product_id', product_id
   end
 
+  # Copy a product record
+  # @param request [Hash] Request payload hash
   def product_copy request={}
     call_params = base_call_params __method__
     call_params[:body] = { 'product_id' => get_if_exists('product_id', request, 0) }
@@ -285,6 +356,8 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Create a product record
+  # @param request [Hash] Request payload hash
   def product_create request={}
     call_params = base_call_params __method__
     call_params[:body] = {
@@ -312,10 +385,14 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Delete a product record
+  # @param product_id [Integer] Product ID from CRM instance
   def product_delete product_id
     common_entity_view_perform_post base_call_params(__method__), 'product_id', product_id
   end
 
+  # Update a product record
+  # @param request [Hash] Request payload hash
   def product_update request={}
     call_params = base_call_params __method__
     update_options = [
@@ -343,6 +420,8 @@ class LimeLightPlatform < AppBase
     common_update_perform_post call_params, request, 'product_id', update_options
   end
 
+  # Search for a prospect record according to one or more criteria
+  # @param request [Hash] Request payload hash
   def prospect_find request={}
     call_params = base_call_params __method__
     date_times = default_date_times
@@ -362,6 +441,8 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Update a prospect record
+  # @param request [Hash] Request payload hash
   def prospect_update request={}
     call_params = base_call_params __method__
     update_options = [
@@ -380,6 +461,8 @@ class LimeLightPlatform < AppBase
     common_update_perform_post call_params, request, 'prospect_id', update_options
   end
 
+  # Retrieve prospect data for a specified prospect ID
+  # @param request [Hash] Request payload hash
   def prospect_view request={}
     call_params = base_call_params __method__
     call_params[:body] = {
@@ -388,10 +471,44 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Attempt to send an order to fulfillment
+  # @param order_id [Integer] The order ID from CRM instance
+  def repost_to_fulfillment order_id
+    common_entity_view_perform_post base_call_params(__method__), 'order_id', order_id
+  end
+
+  # Retrieve shipping method data based upon criteria
+  # @param request [Hash] Request payload hash
+  def shipping_method_find request={}
+    call_params = base_call_params __method__
+    call_params[:body] = {
+      'campaign_id' => get_if_exists('campaign_id', request, 'all'),
+      'search_type' => get_if_exists('search_type', request, 'any') # could be all
+    }
+
+    # criteria options: code, name, group
+    if key_exists('criteria', request)
+      call_params[:body]['criteria'] = request['criteria']
+    end
+
+    common_perform_post call_params
+  end
+
+  # Retrieve shipping method data for a specified shipping ID
+  # @param shipping_id [Integer] The shipping method ID from CRM instance
+  def shipping_method_view shipping_id
+    common_entity_view_perform_post base_call_params(__method__), 'shipping_id', shipping_id
+  end
+
+  # Skips the next billing cycle on a recurring subscription by updating the recurring date
+  #   according to billing model configurations
+  # @param subscription_id [String] Subscription ID on the order
   def skip_next_billing subscription_id
     common_entity_view_perform_post base_call_params(__method__), 'subscription_id', subscription_id
   end
 
+  # Update one or more dynamic properties on a recurring subscription
+  # @param request [Hash] Request payload hash
   def subscription_order_update request={}
     call_params = base_call_params __method__
     call_params[:body]['order_id'] = get_if_exists 'order_id', request
@@ -408,12 +525,16 @@ class LimeLightPlatform < AppBase
     common_optional_param_perform_post call_params, optional_params, request
   end
 
+  # Stop, start, or reset a subscription
+  # @param request [Hash] Request payload hash
   def subscription_update request={}
     call_params = base_call_params __method__
     call_params[:body] = { 'subscription_id' => get_if_exists('subscription_id', request, {}) }
     common_perform_post call_params
   end
 
+  # Stops the recurring status of an upsell product on a subscriptions
+  # @param request [Hash] Request payload hash
   def upsell_stop_recurring request={}
     call_params = base_call_params __method__
     call_params[:body] = {
@@ -423,6 +544,7 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
+  # Validates the API user username and password
   def validate_credentials
     common_perform_post(base_call_params(__method__))
   end

data/lime_light_platform.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'lime_light_platform'
-  s.version     = '1.0.0.17'
+  s.version     = '1.0.0.18'
   s.date        = '2018-05-07'
   s.summary     = "Official Lime Light eCommerce Platform API Ruby Gem (In Development)"
   s.description = "Official Lime Light eCommerce Platform API Ruby Gem (In Development)"

data/spec/coupon_validate_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#coupon_validate " do
+  context "Lime Light Platform - Membership API - coupon_validate " do
+    it "Validates a coupon promo code" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        true
+      )
+      products = [
+        {
+          'product_id' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_PRODUCT_ID_1'],
+          'quantity' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_PRODUCT_QUANTITY_1']
+        }
+      ]
+      response = lime_light.coupon_validate({
+        'campaign_id' => ENV['TEST_COUPON_VALIDATE_CAMPAIGN_ID'],
+        'shipping_id' => ENV['TEST_COUPON_VALIDATE_SHIPPING_ID'],
+        'promo_code' => ENV['TEST_COUPON_VALIDATE_PROMO_CODE'],
+        'email' => ENV['TEST_COUPON_VALIDATE_EMAIL'],
+        'products' => [products.sample]
+      })
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/get_alternative_provider_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#get_alternative_provider" do
+  context "Lime Light Platform - Membership API - get_alternative_provider" do
+    it "Fetches alternative provider API information" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        true
+      )
+      products = [
+        {
+          'product_id' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_PRODUCT_ID_1'],
+          'quantity' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_PRODUCT_QUANTITY_1']
+        }
+      ]
+      response = lime_light.get_alternative_provider({
+        'campaign_id' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_CAMPAIGN_ID'],
+        'alt_pay_type' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_ALT_PAY_TYPE'],
+        'return_url' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_RETURN_URL'],
+        'cancel_url' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_CANCEL_URL'],
+        'amount' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_AMOUNT'],
+        'shipping_id' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_SHIPPING_ID'],
+        'bill_country' => ENV['TEST_GET_ALTERNATIVE_PROVIDER_BILL_COUNTRY'],
+        'products' => products.sample
+      })
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/repost_to_fulfillment_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#repost_to_fulfillment" do
+  context "Lime Light Platform - Membership API - repost_to_fulfillment" do
+    it "Attempts to send an order to fulfillment" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        true
+      )
+      response = lime_light.repost_to_fulfillment ENV['TEST_REPOST_TO_FULFILLMENT_ORDER_ID']
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/shipping_method_find_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#shipping_method_find" do
+  context "Lime Light Platform - Membership API - shipping_method_find" do
+    it "Searches for a shipping method based upon criteria" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        true
+      )
+      criteria = [
+        { 'code' => ENV['TEST_SHIPPING_METHOD_FIND_CRITERIA_CODE'] },
+        {
+          'code' => ENV['TEST_SHIPPING_METHOD_FIND_CRITERIA_CODE'],
+          'name' => ENV['TEST_SHIPPING_METHOD_FIND_CRITERIA_NAME']
+        },
+        { 'group' => ENV['TEST_SHIPPING_METHOD_FIND_CRITERIA_GROUP'] },
+        {
+          'group' => ENV['TEST_SHIPPING_METHOD_FIND_CRITERIA_GROUP'],
+          'name' => ENV['TEST_SHIPPING_METHOD_FIND_CRITERIA_NAME']
+        },
+      ]
+      response = lime_light.shipping_method_find({
+        'campaign_id' => ENV['TEST_SHIPPING_METHOD_FIND_CAMPAIGN_ID'],
+        'search_type' => ENV['TEST_SHIPPING_METHOD_FIND_SEARCH_TYPE'],
+        'criteria' => criteria.sample
+      })
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/shipping_method_view_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#shipping_method_view" do
+  context "Lime Light Platform - Membership API - shipping_method_view" do
+    it "Returns data payload for a specified shipping method" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        true
+      )
+      response = lime_light.shipping_method_view ENV['TEST_SHIPPING_METHOD_VIEW_SHIPPING_ID']
+      expect(response[:success]).to eq true
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lime_light_platform
 version: !ruby/object:Gem::Version
-  version: 1.0.0.17
+  version: 1.0.0.18
 platform: ruby
 authors:
 - Marvin Titus-Casseus
@@ -27,12 +27,15 @@ files:
 - lime_light_platform-1.0.0.14.gem
 - lime_light_platform-1.0.0.15.gem
 - lime_light_platform-1.0.0.16.gem
+- lime_light_platform-1.0.0.17.gem
 - lime_light_platform.gemspec
 - spec/billing_model_view_spec.rb
 - spec/campaign_find_active_spec.rb
 - spec/campaign_view_spec.rb
+- spec/coupon_validate_spec.rb
 - spec/customer_view_spec.rb
 - spec/gateway_view_spec.rb
+- spec/get_alternative_provider_spec.rb
 - spec/new_order_spec.rb
 - spec/offer_view_spec.rb
 - spec/order_find_spec.rb
@@ -52,6 +55,9 @@ files:
 - spec/prospect_find_spec.rb
 - spec/prospect_update_spec.rb
 - spec/prospect_view_spec.rb
+- spec/repost_to_fulfillment_spec.rb
+- spec/shipping_method_find_spec.rb
+- spec/shipping_method_view_spec.rb
 - spec/skip_next_billing_spec.rb
 - spec/spec_helper.rb
 - spec/subscription_order_update_spec.rb