flowcommerce_spree 0.0.1

data/lib/tasks/flowcommerce_spree.rake

@@ -0,0 +1,289 @@
+# frozen_string_literal: true
+
+require 'flowcommerce'
+require 'digest/sha1'
+require 'colorize'
+
+namespace :flowcommerce_spree do
+  logger = FlowcommerceSpree.logger
+  client = FlowcommerceSpree.client(logger: logger)
+  refresher = FlowcommerceSpree::Refresher.new(logger: logger)
+
+  desc 'Listing and possible invocation of all the Flow tasks'
+  task :list_tasks do |t|
+    task_list = `rake -T | grep flowcommerce_spree`.split($RS)
+    @exit = false
+    logger.info "Running task: #{t}"
+
+    loop do
+      puts 'Flowcommerce tasks:'
+      task_list.each_with_index do |task, index|
+        puts format(" %3d. #{task}", (index + 1))
+      end
+
+      print "\nType the task number to be invoked: "
+      task_number = $stdin.gets.to_i
+
+      if (1..task_list.size).cover?(task_number)
+        selected_task_name = task_list[task_number - 1].to_s.split(/\s+/)[1]
+        logger.info "\nRunning: #{selected_task_name}"
+        Rake::Task[selected_task_name].invoke
+        puts
+      else
+        puts "Unknown task number: #{task_number}".red, ''
+      end
+
+      break if @exit
+    end
+  end
+
+  # uploads catalog to Flow API using local Spree database
+  desc 'Upload catalog'
+  task upload_catalog: :environment do |t|
+    update_sum   = 0
+    total_sum    = 0
+    current_page = 0
+    variants     = []
+
+    while current_page == 0 || !variants.empty?
+      current_page += 1
+      variants = Spree::Variant.order('updated_at desc').page(current_page).per(100).all
+
+      variants.each do |variant|
+        total_sum += 1
+        result = variant.sync_product_to_flow
+
+        # skip if sync not needed
+        next $stdout.print "\nVariant #{variant.sku} is synced, no need to update".green unless result
+
+        if result.is_a?(Hash) && result[:error]
+          $stdout.print "\nError uploading #{variant.sku}. Reason: #{result[:error]}".red
+        else
+          update_sum += 1
+          $stdout.print "\n#{variant.sku}: #{variant.product.name} (#{variant.price} #{variant.cost_currency})"
+        end
+      end
+    end
+
+    needed_update = (update_sum == 0 ? 'none' : update_sum).to_s.green
+    puts "\nFor total of #{total_sum.to_s.blue} products, #{needed_update} needed update"
+    t.reenable
+  end
+
+  desc 'Check if ENV vars, center and tier per experience is set'
+  task check: :environment do |t|
+    logger.info 'Environment check'
+    required_env_vars = %w[FLOW_TOKEN FLOW_ORGANIZATION FLOW_BASE_COUNTRY]
+    required_env_vars.each { |el| logger.info " ENV: #{el} - #{ENV[el].present? ? 'present'.green : 'MISSING'.red} " }
+    organization = FlowcommerceSpree::ORGANIZATION
+
+    logger.info 'Experiences:'
+    logger.info " Getting experiences for flow org: #{organization}"
+    experiences = client.experiences.get(organization)
+    logger.info " Got %d experiences - #{experiences.map(&:country).join(', ')}".green % experiences.length
+
+    # create default experience unless one exists
+    logger.info 'Centers:'
+    center_name     = 'default'
+    current_centers = client.centers.get(organization).map(&:key)
+    if current_centers.include?(center_name)
+      logger.info " Default center: #{'present'.green}"
+    else
+      FlowcommerceSpree::Api.run(
+        :put, "/:organization/centers/#{center_name}", {},
+        'key': center_name,
+        'address': { 'contact': { 'name': { 'first': 'Kinto',
+                                            'last': 'Doe' },
+                                  'company': organization,
+                                  'email': 'dcone@test.flow.io',
+                                  'phone': '1-555-444-0001' },
+                     'location': { 'streets': ['88 East Broad Street'],
+                                   'city': 'Columbus',
+                                   'province': 'OH',
+                                   'postal': '43215',
+                                   'country': FlowcommerceSpree::BASE_COUNTRY } },
+        'packaging': [{ 'dimensions': { 'packaging': { 'depth': { 'value': '9', 'units': 'inch' },
+                                                       'length': { 'value': '13', 'units': 'inch' },
+                                                       'weight': { 'value': '1',  'units': 'pound' },
+                                                       'width': { 'value': '3', 'units': 'inch' } } },
+                        'name': 'Big Box',
+                        'number': 'box1' }],
+        'name': 'Spree Test',
+        'services': [{ 'service': 'dhl-express-worldwide' },
+                     { 'service': 'landmark-global' }],
+        'schedule': { 'holiday': 'us_bank_holidays',
+                      'exception': [{ 'type': 'closed',
+                                      'datetime_range': { 'from': '2016-05-05T18:30:00.000Z',
+                                                          'to': '2016-05-06T18:30:00.000Z' } }],
+                      'calendar': 'weekdays',
+                      'cutoff': '16:30' },
+        'timezone': 'US/Eastern'
+      )
+      logger.info " Default center: #{'created'.blue} (run again)"
+    end
+
+    logger.info 'Tiers:'
+    experiences.each do |exp|
+      exp_tiers = client.tiers.get(FlowcommerceSpree::ORGANIZATION, experience: exp.key)
+      count = exp_tiers.length
+      count_desc = count == 0 ? '0 (error!)'.red : count.to_s.green
+      exp_services = exp_tiers.inject([]) { |total, tier| total.push(*tier.services.map(&:id)) }
+      services_str = if exp_services.empty?
+                       'and no delivery services defined!'.red
+                     else
+                       "with #{exp_services.length.to_s.green} delivery services defined (#{exp_services.join(', ')})"
+                     end
+      logger.info " Experience #{exp.key.yellow} has #{count_desc} delivery tiers defined, #{services_str}"
+    end
+
+    logger.info 'Database fields (flow_data):'
+    [Spree::CreditCard, Spree::Product, Spree::Variant, Spree::Order, Spree::Promotion].each do |klass|
+      state = klass.new.respond_to?(:flow_data) ? 'exists'.green : 'not present (run DB migrations)'.red
+      logger.info " #{klass.to_s.ljust(18)} - #{state}"
+    end
+
+    logger.info 'Default store URL:'
+    url = Spree::Store.find_by(default: true).url
+    logger.info " Spree::Store.find_by(default:true).url == \"#{url.blue}\" (ensure this is valid and right URL)"
+
+    # rate cards check
+    ratecard_estimates_path = '/:organization/ratecard_estimates/summaries'
+    origins = []
+    errors = []
+    client.ratecards.get(FlowcommerceSpree::ORGANIZATION).each do |rc|
+      rc.origination_zones.each do |oz|
+        data = FlowcommerceSpree::Api.run(
+          :post, ratecard_estimates_path, {}, origin: oz.country, destination: origins.last || 'USA'
+        )
+
+        if data.is_a?(Hash) && data['code'] == 'generic_error'
+          errors << { origin: oz.country, messages: data['messages'] }
+          next
+        elsif data.is_a?(Array) && !data.empty?
+          origins << oz.country
+        else
+          errors << { origin: oz.country, messages: ['Unknown error'] }
+        end
+      end
+    end
+
+    unless origins.empty?
+      logger.info "\nRate cards set, OK:".green
+      origins.each_with_index do |origin, index|
+        logger.info format(" %3d. #{origin}", (index + 1))
+      end
+    end
+
+    unless errors.empty?
+      logger.info "\nRate cards errors:".red
+      errors.each_with_index do |err, index|
+        logger.info format(" %3d. Origin = #{err[:origin]}, errors:", (index + 1))
+        err[:messages].each do |m|
+          logger.info "      #{m}".red
+        end
+      end
+    end
+    t.reenable
+  end
+
+  desc 'Sync experiences and localized product catalog items from Flow.io'
+  task sync_localized_items: :environment do |t|
+    next t.reenable unless refresher.needs_refresh?
+
+    logger.info 'Sync needed, running ...'.yellow
+
+    FlowcommerceSpree::ImportExperiences.run(with_items: true, client: client, refresher: refresher)
+
+    t.reenable
+  end
+
+  desc 'Force sync (no timeout) experiences and localized product catalog items from Flow.io'
+  task sync_localized_items_forced: :environment do |t|
+    next t.reenable if refresher.in_progress?
+
+    FlowcommerceSpree::ImportExperiences.run(with_items: true, client: client, refresher: refresher)
+
+    t.reenable
+  end
+
+  # checks existence of every item in local product catalog - remove product from flow unless exists locally
+  desc 'Remove unused items from flow catalog'
+  task clean_flow_catalog: :environment do |t|
+    page_size  = 100
+    offset     = 0
+    items      = []
+    promises = []
+    thread_pool = Concurrent::FixedThreadPool.new(5)
+
+    while offset == 0 || items.length == 100
+      items = FlowcommerceSpree::Api.run :get, '/:organization/catalog/items', limit: page_size, offset: offset
+      offset += page_size
+
+      items.each do |item|
+        sku = item['number']
+
+        next if Spree::Variant.exists?(sku: sku)
+
+        promises << Concurrent::Promises.future_on(thread_pool, sku) do |number|
+          FlowcommerceSpree::Api.run :delete, "/:organization/catalog/items/#{number}"
+          $stdout.puts "Removed item: #{number.red}"
+        end
+      end
+    end
+
+    Concurrent::Promises.zip(*promises).value!
+    thread_pool.shutdown
+    thread_pool.wait_for_termination
+    t.reenable
+  end
+
+  # remove all the products from flow.io
+  desc 'Purge Product Catalog on flow.io'
+  task purge_catalog: :environment do |t|
+    page_size  = 100
+    offset     = 0
+    items      = []
+    promises = []
+    thread_pool = Concurrent::FixedThreadPool.new(5)
+
+    while offset == 0 || items.length == 100
+      items = FlowcommerceSpree::Api.run :get, '/:organization/catalog/items', limit: page_size, offset: offset
+      offset += page_size
+
+      items.each do |item|
+        variant_sku = item['number']
+        promises << Concurrent::Promises.future_on(thread_pool, variant_sku) do |sku|
+          FlowcommerceSpree::Api.run :delete, "/:organization/catalog/items/#{sku}"
+          $stdout.puts "Removed item: #{sku.red}"
+        end
+        v = Spree::Variant.find_by(sku: variant_sku)
+        v.flow_data.delete('last_sync_sh1')
+        v.update_column(:meta, v.meta.to_json)
+      end
+    end
+
+    Concurrent::Promises.zip(*promises).value!
+    thread_pool.shutdown
+    thread_pool.wait_for_termination
+    t.reenable
+  end
+
+  desc 'Purge flow_data from all the Variants in the DB'
+  task purge_flow_data: :environment do |t|
+    record_counter = 0
+    Spree::Variant.where("meta->>'flow_data' IS NOT NULL").each do |v|
+      v.truncate_flow_data
+      record_counter += 1
+      print '.'
+      $stdout.flush
+    end
+    logger.info "\nTruncated flow_data on #{record_counter} records"
+
+    t.reenable
+  end
+
+  desc 'Exit list_tasks'
+  task exit: :environment do
+    @exit = true
+  end
+end

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: flowcommerce_spree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aurel Branzeanu
+- Sebastian De Luca
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.7
+- !ruby/object:Gem::Dependency
+  name: flowcommerce
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: flowcommerce-reference
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: spree_backend
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Integration of popular Rails/Spree store framework with e-commerce Flow
+  API
+email:
+- a.branzeanu@datarockets.com
+- sebastian.deluca@mejuri.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- SPREE_FLOW.md
+- app/assets/javascripts/flowcommerce_spree/application.js
+- app/assets/stylesheets/flowcommerce_spree/application.css
+- app/controllers/concerns/current_zone_loader_decorator.rb
+- app/controllers/flowcommerce_spree/webhooks_controller.rb
+- app/helpers/flowcommerce_spree/application_helper.rb
+- app/helpers/spree/admin/orders_helper_decorator.rb
+- app/helpers/spree/core/controller_helpers/flow_io_order_helper_decorator.rb
+- app/mailers/spree/spree_order_mailer_decorator.rb
+- app/models/flowcommerce_spree/settings.rb
+- app/models/spree/credit_card_decorator.rb
+- app/models/spree/flow_io_product_decorator.rb
+- app/models/spree/flow_io_variant_decorator.rb
+- app/models/spree/gateway/spree_flow_gateway.rb
+- app/models/spree/line_item_decorator.rb
+- app/models/spree/order_decorator.rb
+- app/models/spree/promotion_decorator.rb
+- app/models/spree/promotion_handler/coupon_decorator.rb
+- app/models/spree/spree_user_decorator.rb
+- app/models/spree/taxon_decorator.rb
+- app/models/spree/zone_decorator.rb
+- app/models/spree/zones/flow_io_product_zone_decorator.rb
+- app/services/flowcommerce_spree/import_experience_items.rb
+- app/services/flowcommerce_spree/import_experiences.rb
+- app/services/flowcommerce_spree/order_sync.rb
+- app/views/layouts/flowcommerce_spree/application.html.erb
+- app/views/spree/admin/payments/index.html.erb
+- app/views/spree/admin/promotions/edit.html.erb
+- app/views/spree/admin/shared/_order_summary.html.erb
+- app/views/spree/admin/shared/_order_summary_flow.html.erb
+- app/views/spree/order_mailer/confirm_email.html.erb
+- app/views/spree/order_mailer/confirm_email.text.erb
+- config/initializers/flowcommerce_spree.rb
+- config/routes.rb
+- db/migrate/20201021160159_add_type_and_meta_to_spree_zone.rb
+- db/migrate/20201021755957_add_meta_to_spree_tables.rb
+- db/migrate/20201022173210_add_zone_type_to_spree_zone_members.rb
+- db/migrate/20201022174252_add_kind_to_zone.rb
+- lib/flow/error.rb
+- lib/flow/pay_pal.rb
+- lib/flow/simple_gateway.rb
+- lib/flowcommerce_spree.rb
+- lib/flowcommerce_spree/api.rb
+- lib/flowcommerce_spree/engine.rb
+- lib/flowcommerce_spree/experience_service.rb
+- lib/flowcommerce_spree/logging_http_client.rb
+- lib/flowcommerce_spree/logging_http_handler.rb
+- lib/flowcommerce_spree/refresher.rb
+- lib/flowcommerce_spree/session.rb
+- lib/flowcommerce_spree/version.rb
+- lib/flowcommerce_spree/webhook_service.rb
+- lib/simple_csv_writer.rb
+- lib/tasks/flowcommerce_spree.rake
+homepage: https://github.com/mejuri-inc/flowcommerce_spree
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: Integration of Spree with Flow API
+test_files: []