lime_light_platform 1.0.0.10 → 1.0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1273a3af9515840122742d9733e44e4801a34d8f0a3b92f6d803e9b9582bfa6
-  data.tar.gz: 8a230f9bf1d8d5ccdeb249ac2be9254436b0a380b6ac208070d1df3551845bf2
+  metadata.gz: 74e567c971b5a8d52fe545346ee231b607fbdbcc6f4836ada81b7a7ba3b2057b
+  data.tar.gz: 0272d366b707152d7e615032692da8a951eb508fc9a2f95fb0c893961b47c2d1
 SHA512:
-  metadata.gz: 85cd48e5c8c159a98c4efe8c6c61214c7060467217fd5578e9cfa1e17f436398563e4294cd55ccb647f0a82ea0af24ba84c513b74c5ee77d857d7d15e65bbf15
-  data.tar.gz: 6702930d7a00992f4aa59a0cbb4cc00c5b040ef6870971f8fb1122e86ce3edf0fb2bcb3b9cecf0897dbe22766b717a10748a21e70ede8422cdc8a74d0ce68def
+  metadata.gz: 293b5b42057ceb7c9f12853ddffbd6d7b96d14a6ed673c5e8adcd5c968c4b09a6f076d740fe73ec3afc1c3c2434323f28e45afe0b82939870627363c21426f2a
+  data.tar.gz: 18436f834b51696f014ae59dfdedc53cf2828e1d4757dbe25fde3e417e37206355fcf55e479f12cb214c6cd87bf1f34682fff9cbbe65df4f40bd246edf7ae481

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+gem 'rspec', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+gem "awesome_print"
+gem "dotenv-rails"
+gem "activesupport"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    lime_light_platform (1.0.0.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    awesome_print (1.8.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    dotenv (2.4.0)
+    dotenv-rails (2.4.0)
+      dotenv (= 2.4.0)
+      railties (>= 3.2, < 6.0)
+    erubi (1.7.1)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.2-x64-mingw32)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  activesupport
+  awesome_print
+  dotenv-rails
+  lime_light_platform!
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/lib/lime_light_platform/api_error.rb

@@ -0,0 +1,5 @@
+class ApiError < StandardError
+  def initialize(msg = 'Unknown API error')
+    super
+  end
+end

data/lib/lime_light_platform/app_base.rb

@@ -0,0 +1,74 @@
+require 'net/http'
+require 'openssl'
+
+class AppBase
+  # map protocols
+  GET   = 'GET'
+  POST  = 'POST'
+  PATCH = 'PATCH'
+  PUT   = 'PUT'
+
+  BODY_F_JSON      = 'JSON'
+  BODY_F_QUERY_STR = 'HTTP_QUERY_STR'
+  BODY_F_XML       = 'XML'
+  BODY_F_RAW       = 'RAW'
+  BODY_F_NONE      = 'NO_BODY'
+
+  def perform_api_call call_params
+    valid         = true
+    response_body = ''
+    uri           = URI.parse call_params[:url]
+    http          = gen_http uri
+
+    # determine http protocol
+    case call_params[:proto]
+    when POST
+      api_request = Net::HTTP::Post.new uri.request_uri
+    when PATCH
+      api_request = Net::HTTP::Patch.new uri.request_uri
+    when GET
+      api_request = Net::HTTP::Get.new uri.request_uri
+    when PUT
+      api_request = Net::HTTP::Put.new uri.request_uri
+    else
+      valid = false
+    end
+
+    if valid
+      # determine headers if any
+      if !call_params[:headers].nil?
+        call_params[:headers].each do |field|
+          api_request.add_field field[:name], field[:value]
+        end
+      end
+
+      # add request body
+      case call_params[:format]
+      when BODY_F_JSON
+        api_request.body = call_params[:body].to_json
+      when BODY_F_XML
+        api_request.body = call_params[:body].to_xml(:root => call_params[:xml_root])
+      when BODY_F_QUERY_STR
+        api_request.body = call_params[:body].to_query
+      when BODY_F_RAW
+        api_request.body = call_params[:body]
+      when BODY_F_NONE
+        api_request.body = ''
+      end
+
+      # ap "API_REQUEST =>"
+      # ap api_request.body
+      api_response = http.request api_request
+      response_body = api_response.body
+    end
+
+    response_body
+  end
+
+  def gen_http uri
+    http             = Net::HTTP.new uri.host, uri.port
+    http.use_ssl     = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    http
+  end
+end

data/lib/lime_light_platform/helpers/accessor.rb

@@ -0,0 +1,35 @@
+module Helpers
+  module Accessor
+    def get_if_exists key, hash, default=''
+      value = default
+
+      if !hash[key].nil?
+        value = hash[key]
+      end
+
+      value
+    end
+
+    def key_exists key, hash
+      !hash[key].nil?
+    end
+
+    def get_by_key key, hash
+      hash[key]
+    end
+
+    def get_response_code hash={}
+      response_code = ''
+
+      if key_exists 'response_code', hash
+        response_code = hash['response_code']
+      elsif key_exists 'responseCode', hash
+        response_code = hash['responseCode']
+      elsif key_exists 'response', hash
+        response_code = hash['response']
+      end
+
+      response_code
+    end
+  end
+end

data/lime_light_platform.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'lime_light_platform'
+  s.version     = '1.0.0.11'
+  s.date        = '2018-05-07'
+  s.summary     = "Official Lime Light eCommerce Platform API Ruby Gem"
+  s.description = "Official Lime Light eCommerce Platform API Ruby Gem"
+  s.authors     = ["Marvin Titus-Casseus"]
+  s.email       = 'mtitus-casseus@limelightcrm.com'
+  s.files       = ["lib/lime_light_platform.rb"]
+  s.homepage    = 'https://rubygems.org/gems/lime_light_platform'
+  s.license     = 'Lime Light CRM Inc'
+  s.files       = Dir['**/*'].keep_if { |file| File.file?(file) }
+end

data/spec/billing_model_view_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#billing_model_view" do
+  context "Lime Light Platform - Membership API - billing_model_view" do
+    it "Returns all the data for a given set of billing model(s)" do
+      lime_light = LimeLightPlatform.new(ENV['APP_KEY'], ENV['API_USERNAME'], ENV['API_PASSWORD'], ENV['DEV_SUB'])
+      response = lime_light.billing_model_view ENV['TEST_OFFER_ID_1']
+
+      if !response[:success]
+        ap 'TEST FAILED - API RESPONSE'
+        ap response
+      end
+
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/campaign_find_active_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#campaign_find_active" do
+  context "Lime Light Platform - Membership API - campaign_find_active" do
+    it "Returns all active campaigns for the CRM instance" do
+      lime_light = LimeLightPlatform.new(ENV['APP_KEY'], ENV['API_USERNAME'], ENV['API_PASSWORD'], ENV['DEV_SUB'])
+      response = lime_light.campaign_find_active
+
+      if !response[:success]
+        ap 'TEST FAILED - API RESPONSE'
+        ap response
+      end
+
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/campaign_view_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#campaign_view" do
+  context "Lime Light Platform - Membership API - campaign_view" do
+    it "Returns data that describes a given campaign" do
+      lime_light = LimeLightPlatform.new(ENV['APP_KEY'], ENV['API_USERNAME'], ENV['API_PASSWORD'], ENV['DEV_SUB'])
+      response = lime_light.campaign_view ENV['TEST_CAMPAIGNID']
+
+      if !response[:success]
+        ap 'TEST FAILED - API RESPONSE'
+        ap response
+      end
+
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/gateway_view_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#gateway_view" do
+  context "Lime Light Platform - Membership API - gateway_view" do
+    it "Returns data that describes a given gateway" do
+      lime_light = LimeLightPlatform.new(ENV['APP_KEY'], ENV['API_USERNAME'], ENV['API_PASSWORD'], ENV['DEV_SUB'])
+      response = lime_light.gateway_view ENV['TEST_GATEWAY_ID_2']
+
+      if !response[:success]
+        ap 'TEST FAILED - API RESPONSE'
+        ap response
+      end
+
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/new_order_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#campaign_find_active" do
+  context "Lime Light Platform - Transaction API - NewOrder" do
+    it "Places a new order using billing model configuration" do
+      lime_light = LimeLightPlatform.new(ENV['APP_KEY'], ENV['API_USERNAME'], ENV['API_PASSWORD'], ENV['DEV_SUB'])
+      response = lime_light.new_order({
+        'first_name' => ENV['TEST_FIRSTNAME'],
+        'last_name' => ENV['TEST_LASTNAME'],
+        'shipping_address_1' => ENV['TEST_SHIPPINGADDRESS1'],
+        'shipping_address_2' => ENV['TEST_SHIPPINGADDRESS2'],
+        'shipping_city' => ENV['TEST_SHIPPINGCITY'],
+        'shipping_state' => ENV['TEST_SHIPPINGSTATE'],
+        'shipping_zip' => ENV['TEST_SHIPPINGZIP'],
+        'shipping_country' => ENV['TEST_SHIPPINGCOUNTRY'],
+        'billing_first_name' => ENV['TEST_BILLINGFIRSTNAME'],
+        'billing_last_name' => ENV['TEST_BILLINGLASTNAME'],
+        'billing_address_1' => ENV['TEST_BILLINGADDRESS1'],
+        'billing_address_2' => ENV['TEST_BILLINGADDRESS2'],
+        'billing_city' => ENV['TEST_BILLINGCITY'],
+        'billing_state' => ENV['TEST_BILLINGSTATE'],
+        'billing_zip' => ENV['TEST_BILLINGZIP'],
+        'billing_country' => ENV['TEST_BILLINGCOUNTRY'],
+        'phone' => ENV['TEST_PHONE'],
+        'email' => ENV['TEST_EMAIL'],
+        'credit_card_type' => ENV['TEST_CREDITCARDTYPE'],
+        'credit_card_number' => ENV['TEST_CREDITCARDNUMBER'],
+        'expiration_date' => ENV['TEST_EXPIRATIONDATE'],
+        'cvv' => ENV['TEST_CVV'],
+        'shipping_id' => ENV['TEST_SHIPPINGID'],
+        'tran_type' => ENV['TEST_TRANTYPE'],
+        'ip_address' => ENV['TEST_IPADDRESS'],
+        'campaign_id' => ENV['TEST_CAMPAIGNID'],
+        'notes' => ENV['TEST_NOTES'],
+        'utm_source' => ENV['TEST_UTM_SOURCE'],
+        'utm_medium' => ENV['TEST_UTM_MEDIUM'],
+        'utm_campaign' => ENV['TEST_UTM_CAMPAIGN'],
+        'utm_content' => ENV['TEST_UTM_CONTENT'],
+        'utm_term' => ENV['TEST_UTM_TERM'],
+        'products' => {
+          ENV['TEST_PRODUCT_1'] => {
+            'offer_id' => ENV['TEST_OFFER_ID_1'],
+            'billing_model_id' => ENV['TEST_BILLING_MODEL_ID_1'],
+            'quantity' => ENV['TEST_QUANTITY_1']
+          },
+          ENV['TEST_PRODUCT_2'] => {
+            'offer_id' => ENV['TEST_OFFER_ID_2'],
+            'billing_model_id' => ENV['TEST_BILLING_MODEL_ID_2'],
+            'quantity' => ENV['TEST_QUANTITY_3']
+          }
+        }
+      })
+
+      if !response[:success]
+        ap 'TEST FAILED - API RESPONSE'
+        ap response
+      end
+
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/offer_view_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#offer_view" do
+  context "Lime Light Platform - Membersip API - offer_view" do
+    it "Returns offer data for a given campaign" do
+      lime_light = LimeLightPlatform.new(ENV['APP_KEY'], ENV['API_USERNAME'], ENV['API_PASSWORD'], ENV['DEV_SUB'])
+      response = lime_light.offer_view ENV['TEST_CAMPAIGNID']
+
+      if !response[:success]
+        ap 'TEST FAILED - API RESPONSE'
+        ap response
+      end
+
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/product_create_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#product_create" do
+  context "Lime Light Platform - Membersip API - product_create" do
+    it "Creates a Lime Light Product" do
+      lime_light = LimeLightPlatform.new(ENV['APP_KEY'], ENV['API_USERNAME'], ENV['API_PASSWORD'], ENV['DEV_SUB'])
+      response = lime_light.product_create({
+        'customer_purchase_limit' => ENV['TEST_CUSTOMER_PURCHASE_LIMIT'],
+        'taxable' => ENV['TEST_TAXABLE'],
+        'shippable' => ENV['TEST_SHIPPABLE'],
+        'signature_confirmation' => ENV['TEST_SIGNATURE_CONFIRMATION'],
+        'delivery_confirmation' => ENV['TEST_DELIVERY_CONFIRMATION'],
+        'preserve_quantity' => ENV['TEST_PRESERVE_QUANTITY'],
+        'collections' => ENV['TEST_COLLECTIONS'],
+        'shipping_declared_value' => ENV['TEST_SHIPPING_DECLARED_VALUE'],
+        'product_price' => ENV['TEST_PRODUCT_PRICE'],
+        'product_restocking_fee' => ENV['TEST_PRODUCT_RESTOCKING_FEE'],
+        'shipping_weight' => ENV['TEST_SHIPPING_WEIGHT'],
+        'product_sku' => ENV['TEST_PRODUCT_SKU'] + Random.new.rand(10...1000).to_s,
+        'shipping_digital_url' => ENV['TEST_SHIPPING_DIGITAL_URL'],
+        'recurring_discount_max' => ENV['TEST_RECURRING_DISCOUNT_MAX'],
+        'product_name' => ENV['TEST_PRODUCT_NAME'] + Random.new.rand(10...1000).to_s,
+        'product_description' => ENV['TEST_PRODUCT_DESCRIPTION'] + Random.new.rand(10...1000).to_s,
+        'category_id' => ENV['TEST_CATEGORY_ID'],
+        'vertical_id' => ENV['TEST_VERTICAL_ID'],
+        'cost_of_goods_sold' => ENV['TEST_COST_OF_GOODS_SOLD'],
+        'product_max_quantity' => ENV['TEST_PRODUCT_MAX_QUANTITY']
+      })
+
+      if !response[:success]
+        ap 'TEST FAILED - API RESPONSE'
+        ap response
+      end
+
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/product_update_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe LimeLightPlatform, "#product_update" do
+  context "Lime Light Platform - Membersip API - product_update" do
+    it "Updates a Lime Light Product" do
+      lime_light = LimeLightPlatform.new(ENV['APP_KEY'], ENV['API_USERNAME'], ENV['API_PASSWORD'], ENV['DEV_SUB'])
+      response = lime_light.product_update({
+        'product_id' => ENV['TEST_UPDATE_PRODUCT_ID'],
+        'product_name' => ENV['TEST_UPDATE_PRODUCT_NAME'] + Random.new.rand(10...1000).to_s,
+        'product_description' => ENV['TEST_UPDATE_PRODUCT_DESC'] + Random.new.rand(10...1000).to_s
+      })
+
+      if !response[:success]
+        ap 'TEST FAILED - API RESPONSE'
+        ap response
+      end
+
+      expect(response[:success]).to eq true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'lime_light_platform'
+require 'dotenv'
+require 'awesome_print'
+Dotenv.load
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lime_light_platform
 version: !ruby/object:Gem::Version
-  version: 1.0.0.10
+  version: 1.0.0.11
 platform: ruby
 authors:
 - Marvin Titus-Casseus
@@ -16,7 +16,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
 - lib/lime_light_platform.rb
+- lib/lime_light_platform/api_error.rb
+- lib/lime_light_platform/app_base.rb
+- lib/lime_light_platform/helpers/accessor.rb
+- lime_light_platform-1.0.0.10.gem
+- lime_light_platform-1.0.0.7.gem
+- lime_light_platform-1.0.0.8.gem
+- lime_light_platform-1.0.0.9.gem
+- lime_light_platform.gemspec
+- spec/billing_model_view_spec.rb
+- spec/campaign_find_active_spec.rb
+- spec/campaign_view_spec.rb
+- spec/gateway_view_spec.rb
+- spec/new_order_spec.rb
+- spec/offer_view_spec.rb
+- spec/product_create_spec.rb
+- spec/product_update_spec.rb
+- spec/spec_helper.rb
 homepage: https://rubygems.org/gems/lime_light_platform
 licenses:
 - Lime Light CRM Inc