lime_light_platform 1.0.0.14 → 1.0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f04e75d5944c843fa91ebde76c6e6c2257f929c71f1e5b394c6ac81afbf7dcd5
-  data.tar.gz: fb40c35e54d0a17476a98a5c1122f640e0c5c06ce804581c1be4b1cb5e43ec18
+  metadata.gz: a8f9891a2f22cf55275d0096295ca483c400edf7bba69db55db2f2a3e41e783d
+  data.tar.gz: 2210ba3db45baf80089270e92ca3923e9b707f42a57bc6160e2b1556d1b539ad
 SHA512:
-  metadata.gz: 59b210afd6881eb4aaf69810f137a8083e2c479f4926ee18df5d8b6222ec5fc3f0c65c51bac1fc18623e6cd3a32ea679ad9e42a0989cc5bf4730352e0d593f72
-  data.tar.gz: bc27d88cc2a628288d9cbaf0df3f038fcc85a4af6ff226b9c9daee8e201adb712c0302d8d6acd40d0fed420f6da06989d08f9248d5c8e7fb664ea4377123206b
+  metadata.gz: 1d9773c695ce28f6870461d4aa88592788a218103545a30f7dd1cc37f149085ee3e07fa3e4c7c13f533d152e980f76890f21a06323a008f4af856286fa72bf7a
+  data.tar.gz: 691ed15fead9b5058ebb2a85b2afaa2ba693e7c348cc30d230126d154bd4f23cc0003edba40a37ce71fff671a12da2fa63165f11c9f62aec37134fd8ad9cfc4f

data/lib/lime_light_platform.rb

@@ -39,9 +39,17 @@ class LimeLightPlatform < AppBase
     end
   end
 
-  def billing_model_view offer_id
+  def billing_model_view request={}
     call_params = base_call_params __method__
-    call_params[:body]['offer_id'] = offer_id
+
+    if key_exists('offer_id', request)
+      call_params[:body]['offer_id'] = request['offer_id']
+    end
+
+    if key_exists('billing_model_id', request)
+      call_params[:body]['billing_model_id'] = request['billing_model_id']
+    end
+
     common_perform_post call_params
   end
 
@@ -73,15 +81,15 @@ class LimeLightPlatform < AppBase
   end
 
   def campaign_view campaign_id
-    call_params = base_call_params __method__
-    call_params[:body]['campaign_id'] = campaign_id
-    common_perform_post call_params
+    common_entity_view_perform_post base_call_params(__method__), 'campaign_id', campaign_id
+  end
+
+  def customer_view customer_id
+    common_entity_view_perform_post base_call_params(__method__), 'customer_id', customer_id
   end
 
   def gateway_view gateway_id
-    call_params = base_call_params __method__
-    call_params[:body]['gateway_id'] = gateway_id
-    common_perform_post call_params
+    common_entity_view_perform_post base_call_params(__method__), 'gateway_id', gateway_id
   end
 
   def new_order request={}
@@ -125,9 +133,17 @@ class LimeLightPlatform < AppBase
     common_perform_post call_params
   end
 
-  def offer_view campaign_id
+  def offer_view request={}
     call_params = base_call_params __method__
-    call_params[:body]['campaign_id'] = campaign_id
+
+    if key_exists('offer_id', request)
+      call_params[:body]['offer_id'] = request['offer_id']
+    end
+
+    if key_exists('campaign_id', request)
+      call_params[:body]['campaign_id'] = request['campaign_id']
+    end
+
     common_perform_post call_params
   end
 
@@ -320,6 +336,51 @@ class LimeLightPlatform < AppBase
     common_update_perform_post call_params, request, 'product_id', update_options
   end
 
+  def prospect_find request={}
+    call_params = base_call_params __method__
+    date_times = default_date_times
+    call_params[:body] = {
+      'campaign_id' => get_if_exists('campaign_id', request, 'all'),
+      'start_date' => get_if_exists('start_date', request, date_times[:today]),
+      'end_date' => get_if_exists('end_date', request, date_times[:today]),
+      'start_time' => get_if_exists('start_time', request, date_times[:start_time]),
+      'end_time' => get_if_exists('end_time', request, date_times[:end_time]),
+      'search_type' => get_if_exists('search_type', request, 'any'), # could be all
+    }
+
+    if key_exists('criteria', request)
+      call_params[:body]['criteria'] = request['criteria']
+    end
+
+    common_perform_post call_params
+  end
+
+  def prospect_update request={}
+    call_params = base_call_params __method__
+    update_options = [
+      'first_name',
+      'last_name',
+      'address',
+      'address2',
+      'city',
+      'state',
+      'zip',
+      'country',
+      'phone',
+      'email',
+      'notes'
+    ]
+    common_update_perform_post call_params, request, 'prospect_id', update_options
+  end
+
+  def prospect_view request={}
+    call_params = base_call_params __method__
+    call_params[:body] = {
+      'prospect_id' => get_if_exists('prospect_id', request, [])
+    }
+    common_perform_post call_params
+  end
+
   def subscription_order_update
     response = default_response
     response
@@ -352,6 +413,11 @@ class LimeLightPlatform < AppBase
     { success: false, code: nil, data: [], raw: '' }
   end
 
+  def common_entity_view_perform_post call_params, record_key, record_id
+    call_params[:body][record_key] = record_id
+    common_perform_post call_params
+  end
+
   def common_perform_post call_params
     response = default_response
     api_response = perform_api_call call_params

data/lime_light_platform.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'lime_light_platform'
-  s.version     = '1.0.0.14'
+  s.version     = '1.0.0.15'
   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/billing_model_view_spec.rb

@@ -10,7 +10,15 @@ RSpec.describe LimeLightPlatform, "#billing_model_view" do
         ENV['DEV_SUB'],
         false
       )
-      response = lime_light.billing_model_view ENV['TEST_OFFER_ID_1']
+      possible_params = [
+        {'offer_id' => ENV['TEST_BILLING_MODEL_VIEW_OFFER_ID']},
+        {'billing_model_id' => ENV['TEST_BILLING_MODEL_VIEW_BILLING_MODEL_ID']},
+        {
+          'offer_id' => ENV['TEST_BILLING_MODEL_VIEW_OFFER_ID'],
+          'billing_model_id' => ENV['TEST_BILLING_MODEL_VIEW_BILLING_MODEL_ID']
+        },
+      ]
+      response = lime_light.billing_model_view possible_params.sample
       expect(response[:success]).to eq true
     end
   end

data/spec/customer_view_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#customer_view" do
+  context "Lime Light Platform - Membership API - customer_view" do
+    it "Returns data that describes a given customer" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        false
+      )
+      response = lime_light.customer_view ENV['TEST_CUSTOMER_VIEW_CUSTOMER_ID']
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/offer_view_spec.rb

@@ -10,7 +10,15 @@ RSpec.describe LimeLightPlatform, "#offer_view" do
         ENV['DEV_SUB'],
         false
       )
-      response = lime_light.offer_view ENV['TEST_OFFER_VIEW_CAMPAIGN_ID']
+      possible_params = [
+        {'offer_id' => ENV['TEST_OFFER_VIEW_OFFER_ID']},
+        {'campaign_id' => ENV['TEST_OFFER_VIEW_CAMPAIGN_ID']},
+        {
+          'offer_id' => ENV['TEST_OFFER_VIEW_OFFER_ID'],
+          'campaign_id' => ENV['TEST_OFFER_VIEW_CAMPAIGN_ID']
+        },
+      ]
+      response = lime_light.offer_view possible_params.sample
       expect(response[:success]).to eq true
     end
   end

data/spec/prospect_find_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#prospect_find" do
+  context "Lime Light Platform - Membership API - prospect_find" do
+    it "Searches for a prospect" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        true
+      )
+      possible_criteria = [
+        {
+          'first_name' => ENV['TEST_PROSPECT_FIND_CRITERIA_FIRST_NAME'],
+          'last_name' => ENV['TEST_PROSPECT_FIND_CRITERIA_LAST_NAME']
+        },
+        {
+          'address' => ENV['TEST_PROSPECT_FIND_CRITERIA_ADDRESS'],
+          'city' => ENV['TEST_PROSPECT_FIND_CRITERIA_CITY']
+        },
+        { 'state' => ENV['TEST_PROSPECT_FIND_CRITERIA_STATE'] },
+        { 'zip' => ENV['TEST_PROSPECT_FIND_CRITERIA_ZIP'] },
+        { 'country' => ENV['TEST_PROSPECT_FIND_CRITERIA_COUNTRY'] },
+        { 'phone' => ENV['TEST_PROSPECT_FIND_CRITERIA_PHONE'] },
+        { 'email' => ENV['TEST_PROSPECT_FIND_CRITERIA_EMAIL'] },
+        { 'ip_address' => ENV['TEST_PROSPECT_FIND_CRITERIA_IP_ADDRESS'] }
+      ]
+      response = lime_light.prospect_find({
+        'campaign_id' => ENV['TEST_PROSPECT_FIND_CAMPAIGN_ID'],
+        'start_date' => ENV['TEST_PROSPECT_FIND_START_DATE'],
+        'end_date' => ENV['TEST_PROSPECT_FIND_END_DATE'],
+        'start_time' => ENV['TEST_PROSPECT_FIND_START_TIME'],
+        'end_time' => ENV['TEST_PROSPECT_FIND_END_TIME'],
+        'search_type' => ENV['TEST_PROSPECT_FIND_SEARCH_TYPE'],
+        'criteria' => possible_criteria.sample
+      })
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/prospect_update_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'faker'
+
+RSpec.describe LimeLightPlatform, "#prospect_update" do
+  context "Lime Light Platform - Membership API - prospect_update" do
+    it "Updates a prospect" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        true
+      )
+      options = [
+        {
+          'notes' => Faker::RickAndMorty.quote,
+          'first_name' => Faker::Name.first_name,
+          'last_name' => Faker::Name.last_name,
+          'email' => Faker::Internet.email,
+          'phone' => Faker::PhoneNumber.phone_number
+        },
+        {
+          'address' => Faker::Address.street_address,
+          'address2' => Faker::Address.secondary_address,
+          'city' => Faker::Address.city
+        },
+        {
+          'zip' => Faker::Address.postcode,
+          'state' => Faker::Address.state_abbr,
+          'country' => Faker::Address.country_code
+        }
+      ]
+      response = lime_light.prospect_update({
+        'prospect_id' => {
+          ENV['TEST_PROSPECT_UPDATE_PROSPECT_ID_1'] => options.sample,
+          ENV['TEST_PROSPECT_UPDATE_PROSPECT_ID_2'] => options.sample,
+          ENV['TEST_PROSPECT_UPDATE_PROSPECT_ID_3'] => options.sample
+        }
+      })
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/prospect_view_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#prospect_view" do
+  context "Lime Light Platform - Membership API - prospect_view" do
+    it "Returns data that describes a given prospect" do
+      lime_light = LimeLightPlatform.new(
+        ENV['APP_KEY'],
+        ENV['API_USERNAME'],
+        ENV['API_PASSWORD'],
+        ENV['DEV_SUB'],
+        true
+      )
+      response = lime_light.prospect_view({
+        'prospect_id' => [
+          ENV['TEST_PROSPECT_UPDATE_PROSPECT_ID_2'],
+          ENV['TEST_PROSPECT_UPDATE_PROSPECT_ID_3']
+        ]
+      })
+      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.14
+  version: 1.0.0.15
 platform: ruby
 authors:
 - Marvin Titus-Casseus
@@ -24,10 +24,12 @@ files:
 - lib/lime_light_platform/helpers/accessor.rb
 - lime_light_platform-1.0.0.12.gem
 - lime_light_platform-1.0.0.13.gem
+- lime_light_platform-1.0.0.14.gem
 - lime_light_platform.gemspec
 - spec/billing_model_view_spec.rb
 - spec/campaign_find_active_spec.rb
 - spec/campaign_view_spec.rb
+- spec/customer_view_spec.rb
 - spec/gateway_view_spec.rb
 - spec/new_order_spec.rb
 - spec/offer_view_spec.rb
@@ -40,6 +42,9 @@ files:
 - spec/order_view_spec.rb
 - spec/product_create_spec.rb
 - spec/product_update_spec.rb
+- spec/prospect_find_spec.rb
+- spec/prospect_update_spec.rb
+- spec/prospect_view_spec.rb
 - spec/spec_helper.rb
 - spec/validate_credentials_spec.rb
 homepage: https://rubygems.org/gems/lime_light_platform