spree_gladly 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79f58571478fed7fa33637006c8b2157fc3b78816ba0c8607bfe1bfb940b390e
-  data.tar.gz: 4d8d50389dec9a281fc53b023e1d58fcec863116938d1b50671703012bd5fe85
+  metadata.gz: 838966d87c3ac9621653856b60d79a1b55b318efaa16a1bb532c255f48982d1f
+  data.tar.gz: 1243ce174014bc76281167c3b9a9ed7d5b0fc0620dbca2132661d5e367cad8f6
 SHA512:
-  metadata.gz: be1fdeefa5f51e74dd636703e72b385e8c40c10d0a6e1ce2d153e0c7bfc09869b93cdf579f2ff1d5fc2721bfd56b62c4d62703f24dcc7d745b2439921b6998a8
-  data.tar.gz: ece65399dc55fd6f0cde6c5554e93c683d45cabb9c749341137fc7fb7bca78cd06f618c6a80d86020dc292c92df277b3de35da0c1dcc2db6e119b7d302b08ac4
+  metadata.gz: 07b9c6075897f3cf6023b38eff000c950359c3fefcbd5c89936ce54e42f1891a285e4555ffe15a0016dae5dd99343a9ba8ef26ebe7924719c6a88161aa84d1f3
+  data.tar.gz: 9acf57058969584c7b63afd13f388684679b5e2a36e352d2fabdc4eae5777ea0ad8730ece1192f98bb1e758da4b26a44e2dcf5814513ef1c0f49965504e37f60

data/.travis.yml

@@ -14,7 +14,6 @@ services:
 language: ruby
 
 rvm:
-  - 2.3
   - 2.4
   - 2.5
   - 2.7
@@ -28,6 +27,9 @@ gemfile:
   - gemfiles/spree_3_0.gemfile
   - gemfiles/spree_3_1.gemfile
   - gemfiles/spree_3_7.gemfile
+  - gemfiles/spree_4_0.gemfile
+  - gemfiles/spree_4_1.gemfile
+  - gemfiles/spree_4_2.gemfile
   - gemfiles/spree_master.gemfile
 
 jobs:
@@ -35,14 +37,16 @@ jobs:
   allow_failures:
     - gemfile: gemfiles/spree_master.gemfile
   exclude:
-    - rvm: 2.3
-      gemfile: gemfiles/spree_3_7.gemfile
-    - rvm: 2.3
-      gemfile: gemfiles/spree_master.gemfile
     - rvm: 2.4
       gemfile: gemfiles/spree_3_7.gemfile
     - rvm: 2.4
       gemfile: gemfiles/spree_master.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/spree_4_0.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/spree_4_1.gemfile
+    - rvm: 2.4
+      gemfile: gemfiles/spree_4_2.gemfile
     - rvm: 2.5
       gemfile: gemfiles/spree_3_0.gemfile
     - rvm: 2.5
@@ -59,6 +63,10 @@ jobs:
       gemfile: gemfiles/spree_3_1.gemfile
     - rvm: 3.0
       gemfile: gemfiles/spree_3_7.gemfile
+    - rvm: 3.0
+      gemfile: gemfiles/spree_4_0.gemfile
+    - rvm: 3.0
+      gemfile: gemfiles/spree_4_1.gemfile
 
 script:
   - bundle exec rake test_app

data/README.md

@@ -31,6 +31,8 @@ Supported Spree versions: `3.0`, `3.1`, `3.7`, `4.0`, `4.1`, `4.2`
       - [Basic search](#basic-search)
       - [Detailed search](#detailed-search)
   - [Customization](#customization)
+    - [Events](#events)
+      - [Configuration](#configuration)
   - [Setup sandbox environment](#setup-sandbox-environment)
   - [Testing](#testing)
   - [Contributing](#contributing)
@@ -111,7 +113,94 @@ end
 ***Note: please adjust migration to yours Rails version***
 
 
-### Gladly Service side
+### Gladly Service side:
+
+Provide to your agent:
+- lookup endpoint (  `https://example-spree-store.com/api/v1/customers/lookup` ), where `https://example-spree-store.com` is **your** Spree store URL.
+- signing_key 
+
+
+## Events
+
+### Description
+Within gem we introduce [Conversations (Create Item)](https://developer.gladly.com/rest/#operation/createItem) using API client. 
+We implemented two events against `Spree::Order` model:
+ - `Placed` - it's fired up after Order is completed by customer ( `Gladly::Events::Order::Placed`)
+ - `Refundned` - it's fired up after Order items are returned to customer  ( `Gladly::Events::Order::Refunded`)
+ 
+More about [Conversations](https://developer.gladly.com/rest/#tag/Conversations)
+
+### Configuration
+
+**Important !!!** 
+
+**Without bellow settings events will won't work. You will get those from yours Gladly dashboard**
+
+```ruby
+config.gladly_api_username = 'api_username@example.com'
+config.gladly_api_key = 'api_key'
+config.gladly_api_base_url = 'https://dev-example.gladly.qa'
+config.turn_off_built_in_events = false
+```
+
+In case when you need write your own events class you can switch off built-in events by setting `turn_off_built_in_events` as `true`
+
+
+## Customization
+
+Within `spree_gladly` gem we distinguish response for `guest` and `registerd` customer. For customize those, i.e [detailed lookup response](#detailed-lookup), to do that you have do following steps:
+
+1. replace `Customer::DetailedLookupPresenter` in `config/initializers/spree_gladly.rb` initializer file with your own.
+2. override methods `registerd_presenter` ( [default presenter](https://github.com/upsidelab/spree_gladly/blob/master/app/presenters/customer/registered/detailed_presenter.rb) ) or `guest_presenter` ( [default presenter](https://github.com/upsidelab/spree_gladly/blob/master/app/presenters/customer/guest/detailed_presenter.rb) ) with your own. 
+
+Please consider below example:
+
+```ruby
+class GladlyCustomersPresenter
+  include Spree::Core::Engine.routes.url_helpers # this is important if you want to use Spree routes
+
+  def initialize(resource:)
+    @resource = resource
+  end
+
+  def to_h
+    return [] unless resource.customer.present?
+
+    resource.guest ? guest_presenter : registered_presenter
+  end
+
+  private
+
+  attr_reader :resource
+
+  def registered_presenter
+    YourOwn::DetailedPresenter.new(resource: resource).to_h
+  end
+
+  def guest_presenter
+    Customer::Guest::DetailedPresenter.new(resource: resource).to_h
+  end
+  ...
+end
+```
+
+`config/initializers/spree_gladly.rb`
+
+```ruby
+SpreeGladly.setup do |config|
+  # ...
+  
+  config.basic_lookup_presenter = Customer::BasicLookupPresenter
+  config.detailed_lookup_presenter = GladlyCustomersPresenter
+
+  # ...
+end
+```
+
+**!!! Important !!!**
+
+If you would like to resign from `to_h` or change `initialize(resource:)` method, you have to override  `Spree::Api::V1::CustomersController#serialize_collection` to do that, please follow by this [guide](https://guides.spreecommerce.org/developer/customization/logic.html#extending-controllers)
+
 
 To understand how to set up the integration in Gladly please refer to the Gladly help docs
 

data/app/models/spree/order_decorator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Spree
+  module OrderDecorator
+    def self.prepended(base)
+      base.state_machine do
+        after_transition to: :complete, do: :send_placed_order_event
+      end
+    end
+
+    def send_placed_order_event
+      Gladly::Events::Order::Placed.new(order: self).call
+    end
+  end
+end
+::Spree::Order.prepend(Spree::OrderDecorator)

data/app/models/spree/refund_decorator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spree
+  module RefundDecorator
+    def perform!
+      super
+      Gladly::Events::Order::Refunded.new(order: payment.order, refund: self).call
+    end
+  end
+end
+::Spree::Refund.prepend(Spree::RefundDecorator)

data/app/models/spree_gladly/configuration.rb

@@ -8,7 +8,11 @@ module SpreeGladly
                   :order_limit,
                   :order_includes,
                   :order_sorting,
-                  :order_states
+                  :order_states,
+                  :gladly_api_username,
+                  :gladly_api_key,
+                  :gladly_api_base_url,
+                  :turn_off_built_in_events
 
     @basic_lookup_presenter = nil
 
@@ -21,5 +25,13 @@ module SpreeGladly
     @order_sorting = nil
 
     @order_states = nil
+
+    @gladly_api_username = nil
+
+    @gladly_api_key = nil
+
+    @gladly_api_base_url = nil
+
+    @turn_off_built_in_events = nil
   end
 end

data/app/services/gladly/api/client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module Gladly
+  module Api
+    class Client
+      include Gladly::Api::ErrorHandling
+
+      def initialize(payload: {})
+        @api_username = SpreeGladly::Config.gladly_api_username
+        @api_key = SpreeGladly::Config.gladly_api_key
+        @base_url = SpreeGladly::Config.gladly_api_base_url
+        @payload = payload
+      end
+
+      def call
+        return if base_url.blank?
+
+        perform_request
+      end
+
+      def perform_request
+        post_request if request_method.eql?(:post)
+      end
+
+      def post_request
+        uri = URI(request_url)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.open_timeout = 20
+        http.use_ssl = true
+
+        request = Net::HTTP::Post.new(uri.path)
+        request.basic_auth(api_username, api_key)
+        request.body = payload.to_json
+
+        response = http.request(request)
+
+        formatted_response(response: response)
+      end
+
+      def request_url
+        "#{base_url}#{resource_url}"
+      end
+
+      def request_method
+        not_implemented_error
+      end
+
+      def resource_url
+        not_implemented_error
+      end
+
+      private
+
+      attr_reader :base_url, :api_key, :api_username, :payload
+
+      def formatted_response(response:)
+        parse_error(error: response) if net_http_errors.include?(response.class.to_s)
+
+        { id: JSON.parse(response.body)['id'], code: response.code, status: response.msg }
+      end
+    end
+  end
+end

data/app/services/gladly/api/conversations/create.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gladly
+  module Api
+    module Conversations
+      class Create < Gladly::Api::Client
+        def request_method
+          :post
+        end
+
+        def resource_url
+          '/api/v1/conversation-items'
+        end
+      end
+    end
+  end
+end

data/app/services/gladly/api/error_handling.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gladly
+  module Api
+    module ErrorHandling
+      # rubocop:disable Layout/LineLength
+      def net_http_errors
+        %w[Timeout::Error Errno::EINVAL Errno::ECONNRESET EOFError Net::HTTPBadResponse Net::HTTPHeaderSyntaxError Net::ProtocolError Net::HTTPUnauthorized]
+      end
+      # rubocop:enable Layout/LineLength
+
+      def parse_error(error:)
+        { errors: [{ code: error.code, detail: error.msg }] }
+      end
+
+      def not_implemented_error
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/app/services/gladly/events/order/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Gladly
+  module Events
+    module Order
+      class Base
+        include Spree::Core::Engine.routes.url_helpers
+
+        def initialize(order:, refund: nil)
+          @order = order
+          @refund = refund
+        end
+
+        # rubocop:disable Layout/LineLength
+        def call
+          Gladly::Api::Conversations::Create.new(payload: payload).call unless SpreeGladly::Config.turn_off_built_in_events
+        end
+        # rubocop:enable Layout/LineLength
+
+        private
+
+        attr_reader :order, :refund
+
+        def customer_email
+          order.email || order.user.email
+        end
+
+        def order_url
+          edit_admin_order_url(id: order.number, host: Rails.application.routes.default_url_options[:host])
+        end
+      end
+    end
+  end
+end

data/app/services/gladly/events/order/placed.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Gladly
+  module Events
+    module Order
+      class Placed < Gladly::Events::Order::Base
+        private
+
+        def payload
+          {
+            customer: {
+              emailAddress: customer_email
+            },
+            content: {
+              type: 'CUSTOMER_ACTIVITY',
+              title: "Order #{order.number}",
+              body: body_content,
+              activityType: 'EMAIL',
+              sourceName: 'Spree',
+              link: {
+                url: order_url,
+                text: 'Link to Order - Spree'
+              }
+            }
+          }
+        end
+
+        def body_content
+          [
+            "Order Total: #{Spree::Money.new(order.total).to_html}",
+            "Item Total: #{Spree::Money.new(order.line_items.map(&:total).sum).to_html}",
+            "Adjustment Total: #{Spree::Money.new(order.adjustment_total).to_html}"
+          ].join('<br>')
+        end
+      end
+    end
+  end
+end

data/app/services/gladly/events/order/refunded.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Gladly
+  module Events
+    module Order
+      class Refunded < Gladly::Events::Order::Base
+        private
+
+        def payload
+          {
+            customer: {
+              emailAddress: customer_email
+            },
+            content: {
+              type: 'CUSTOMER_ACTIVITY',
+              title: "Order Adjusted #{order.number}",
+              body: body_content,
+              activityType: 'EMAIL',
+              sourceName: 'Spree',
+              link: {
+                url: order_url,
+                text: 'Link to Order - Spree'
+              }
+            }
+          }
+        end
+
+        def body_content
+          [
+            "Amount Adjusted: #{Spree::Money.new(refund.amount).to_html}",
+            "Adjustment Reason: #{refund.reason&.name}"
+          ].join('<br>')
+        end
+      end
+    end
+  end
+end

data/lib/generators/spree_gladly/install/templates/config/initializers/spree_gladly.rb

@@ -15,4 +15,9 @@ SpreeGladly.setup do |config|
   # Setting this value to `0` disables the threshold validation.
   # Default is `0`.
   # config.signing_threshold = 5.minutes
+
+  # API CONFIG
+  config.gladly_api_username = ''
+  config.gladly_api_key = ''
+  config.gladly_api_base_url = ''
 end

data/lib/spree_gladly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SpreeGladly
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_gladly
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Upsidelab.io
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -135,6 +135,8 @@ files:
 - app/finders/customer/guest/detailed_finder.rb
 - app/finders/customer/registered/basic_finder.rb
 - app/finders/customer/registered/detailed_finder.rb
+- app/models/spree/order_decorator.rb
+- app/models/spree/refund_decorator.rb
 - app/models/spree_gladly/configuration.rb
 - app/overrides/add_gladly_admin_menu_links.rb
 - app/presenters/customer/address_presenter.rb
@@ -152,6 +154,12 @@ files:
 - app/services/auth/request_normalizer.rb
 - app/services/auth/signature_validator.rb
 - app/services/auth/time_header.rb
+- app/services/gladly/api/client.rb
+- app/services/gladly/api/conversations/create.rb
+- app/services/gladly/api/error_handling.rb
+- app/services/gladly/events/order/base.rb
+- app/services/gladly/events/order/placed.rb
+- app/services/gladly/events/order/refunded.rb
 - app/validators/lookup_validator.rb
 - app/validators/validation_result.rb
 - app/views/spree/admin/gladly_settings/edit.html.erb
@@ -194,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.17
 signing_key:
 specification_version: 4
 summary: Spree Connector API