solidus-returnly 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 770f17457a8c4b1ef1e54ea9693055061f3dc437
+  data.tar.gz: cf0ff331d9a612981c085b4e831dd6cd24c6313f
+SHA512:
+  metadata.gz: f21ab272464d7d9727094bde59dc4b386e644d0f0a0b94e720f6383179dec22f0175188fa844e2cbd905e4aaf052fa229159173b5e4ff0647c07b5c6dbe48b5a
+  data.tar.gz: ed2e2506d1ae775b53daf470eb1e1524a7801a3172d263de89b83c7b3ac7a32b8bd1acc1fb22f20f08205ab6425fef0207d2ef04e47351c120e1824002e6cbb9

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Returnly Technologies, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,152 @@
+Solidus Returnly
+===============
+
+This gem adds the required apis to allow returnly obtain an estimate, process a return and apply a reimbursement
+
+Installation
+------------
+
+Add solidus_returnly to your Gemfile:
+
+```ruby
+gem 'solidus-returnly'
+```
+
+Bundle your dependencies and run the installation generator:
+
+```shell
+bundle
+bundle exec rails g solidus_returnly:install
+```
+
+Testing
+-------
+
+First bundle your dependencies, then run `rake`. `rake` will default to building the dummy app if it does not exist, then it will run specs, and [Rubocop](https://github.com/bbatsov/rubocop) static code analysis. The dummy app can be regenerated by using `rake test_app`.
+
+```shell
+bundle
+bundle exec rake
+```
+
+When testing your applications integration with this extension you may use it's factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'solidus_returnly/factories'
+```
+
+Solidus/Spree Sandbox 
+---------------------
+
+You can create a sandbox spree installationm
+```shell
+git clone git@github.com:solidusio/solidus.git
+cd solidus
+git co v2.0
+bundle install
+rake sandbox
+cd sandbox
+rake spree_auth:admin:create
+```
+
+default admin credentials:
+```
+Email [admin@example.com]
+Password [test123]
+```
+
+this will create a pristine solidus installation you can add the `solidus_returnly` gem and test the endpoints live  
+
+API 
+---
+
+To get an estimate of the return order and taxes
+
+`POST /api/orders/:order_number/refunds/estimate`
+
+Payload:
+```json
+{
+  "line_items": [
+    { 
+      "order_line_item_id": "{spree order line item id}", 
+      "quantity": 1
+    }
+  ]
+}
+```
+
+Response:
+
+```json 
+{
+  "total_amount": "{money}",
+  "subtotal_amount": "{money}",
+  "tax_amount": "{money}",
+  "discount_amount": "{money}",
+  "shipping_amount": "{money}",
+  "line_items": [
+    {
+      "order_line_item_id": "{x_order_line_item_id1}",
+      "quantity": 1,
+      "total_amount": "{money}",
+      "subtotal_amount": "{money}",
+      "tax_amount": "{money}",
+      "discount_amount": "{money}",
+    }
+  ]
+}
+```
+
+To process the return and apply the reimbursement**immediately** 
+you can pass the `restock` parameter on false to prevent the api
+to immediately change the stock in the default warehouse
+
+`POST /api/orders/:order_number/refunds/estimate`
+
+Payload:
+
+```json
+{  
+  "line_items": [    
+    { 
+      "order_line_item_id": "{x_order_line_item_id1}",
+      "quantity": 2 
+    },  
+  ],
+  "transactions": {
+    "parent_id": "{parent (order) tx id}",
+    "amount": "{money}"
+  },
+  "note": "comment text",
+  "restock": true
+}
+```
+
+Responce:
+
+```json 
+{
+  "refund_id": "{x_refund_id}",
+  "created_at": "{timestamp}",
+  "updated_at": "{timestamp}",
+  "user_id": "{optional merchant user ID}",
+  "line_items": [    
+    { 
+      "refund_line_item_id": "{x_refund_line_item_id1}",
+      "order_line_item_id": "{x_order_line_item_id1}", 
+      "quantity": 2 
+    },  
+  ],
+  "transactions": [
+    "id": "{refund tx id}",
+    "amount": "{money}"
+  ],
+  "note": "comment text",
+  "restock": true
+}
+```
+
+
+Copyright (c) 2017 Returnly Technologies, Inc

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+begin
+  require 'spree/testing_support/extension_rake'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: %i(first_run spec)
+rescue LoadError
+  # no rspec available
+end
+
+task :first_run do
+  if Dir['spec/dummy'].empty?
+    Rake::Task[:test_app].invoke
+    Dir.chdir('../../')
+  end
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'solidus/returnly'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/controllers/spree/api/refunds_controller.rb

@@ -0,0 +1,40 @@
+module Spree
+  module Api
+    class RefundsController < Spree::Api::BaseController
+
+      def estimate
+        authorize! :create, Order
+        render json: SolidusReturnly::Calculator.process(order, line_items_params)
+      end
+
+      def create
+        authorize! :create, Order
+
+        refunds = SolidusReturnly::Refunds.new order: order,
+                                               line_items: line_items_params,
+                                               restock: refund_restock_param,
+                                               transactions: transactions_params
+        render json: refunds.proceed!
+      end
+
+      private
+
+      def line_items_params
+        params.require(:line_items)
+      end
+      
+      def transactions_params
+        params.require(:transactions)
+      end
+
+      def refund_restock_param
+        params.require(:restock) == 'true'
+      end
+
+      def order
+        @order ||= Spree::Order.find_by(number: params[:order_id])
+      end
+    end
+  end
+end
+

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: Hello world

data/config/routes.rb

@@ -0,0 +1,6 @@
+Spree::Core::Engine.routes.draw do
+  namespace :api, defaults: { format: 'json' } do
+    post '/orders/:order_id/refunds/estimate', to: 'refunds#estimate'
+    post '/orders/:order_id/refunds', to: 'refunds#create'
+  end
+end

data/lib/generators/solidus_returnly/install/install_generator.rb

@@ -0,0 +1,19 @@
+module SolidusReturnly
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_javascripts
+      end
+
+      def add_stylesheets
+      end
+
+      def add_migrations
+      end
+
+      def run_migrations
+      end
+    end
+  end
+end

data/lib/solidus/returnly.rb

@@ -0,0 +1,5 @@
+require 'solidus_core'
+
+require 'solidus_returnly/engine'
+require 'solidus_returnly/refunds'
+require 'solidus_returnly/calculator'

data/lib/solidus_returnly/calculator.rb

@@ -0,0 +1,98 @@
+module SolidusReturnly
+  class Calculator
+    attr_accessor :line_items, :order
+
+    def self.process(order, line_items)
+      new(order, line_items).calculated_estimate
+    end
+
+    def initialize(order, line_items)
+      self.line_items = line_items
+      self.order = order
+    end
+
+    def calculated_estimate
+      total = line_items_return_items.values.sum{|iu| iu.sum(&:pre_tax_amount) }
+
+      tax_amount = returnable_inventory_units.sum do |inventory_unit|
+        calculate_tax inventory_unit
+      end
+
+      {
+          total_amount: total,
+          subtotal_amount: total - tax_amount,
+          tax_amount: tax_amount,
+          discount_amount: order.promo_total,
+          shipping_amount: order.shipment_total,
+          line_items: present_line_items
+      }
+    end
+
+    def present_line_items
+      line_items_return_items.map do| line_item_id, inventory_units|
+        line_item = line_item(line_item_id)
+
+        {
+            order_line_item_id: line_item.id,
+            quantity: inventory_units.size,
+            total_amount: inventory_units.sum(&:amount),
+            tax_amount: line_item.included_tax_total,
+            discount_amount: line_item.adjustment_total,
+        }
+      end
+    end
+
+
+    def calculate_tax(inventory_unit)
+      return_item = Spree::ReturnItem.from_inventory_unit(inventory_unit)
+      (return_item.amount <= 0) ? 0 : return_item.amount /
+          Spree::ReturnItem.refund_amount_calculator.new.compute(return_item)
+    end
+
+
+    def line_items_return_items
+      found_return_items = {}
+
+      self.line_items.each do |line_item|
+        quantity = line_item[:quantity].to_i
+
+        if quantity > 0
+          available_inventory_units = line_item_inventory_unit(line_item).slice(0, quantity)
+
+          available_inventory_units.each do |inventory_unit|
+            found_return_items[line_item[:order_line_item_id]] ||= []
+            found_return_items[line_item[:order_line_item_id]] << Spree::ReturnItem.new({amount: inventory_unit.line_item.price,
+                                                                                         acceptance_status: 'accepted',
+                                                                                         inventory_unit_id: inventory_unit.id,
+                                                                                         reception_status_event: 'receive'
+                                                                                        })
+          end
+        end
+      end
+
+      found_return_items
+    end
+
+    def line_item_inventory_unit(line_item)
+      returnable_inventory_units.select{|iu| iu.line_item_id == line_item[:order_line_item_id].to_i }
+    end
+
+    def line_item(id)
+      returnable_line_items.select{|i| i.id == id.to_i }.first
+    end
+
+    def returnable_inventory_units
+      @_inventory_units ||= order.inventory_units.includes(:line_item)
+                                .where(line_item_id: requested_line_items)
+                                .where('state is not "returned"')
+    end
+
+    def returnable_line_items
+      @_line_items ||= returnable_inventory_units.map(&:line_item)
+    end
+
+    def requested_line_items
+      line_items.map { |item| item[:order_line_item_id] }
+    end
+  end
+end

data/lib/solidus_returnly/engine.rb

@@ -0,0 +1,53 @@
+module SolidusReturnly
+  class Engine < Rails::Engine
+    require 'spree/core'
+    
+    engine_name 'solidus_returnly'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+
+    rake_tasks do
+      namespace :returnly do
+        require 'securerandom'
+
+        desc "Creates an returnly user and prints the generated API key"
+        task install_user: :environment do
+          returnly_email = 'api@returnly.coim'
+
+          password = SecureRandom.hex(24)
+
+          if (user = Spree::User.find_by email: returnly_email)
+            puts "The Returnly User is already generated"
+            puts "The Api key is:    #{user.spree_api_key}"
+          else
+            user = Spree::User.new email: returnly_email, password: password,
+                                   password_confirmation: password
+
+            api_key = user.generate_spree_api_key
+
+            if user.save!
+              puts "****************************************************"
+              puts "Api key Generated #{api_key}"
+              puts "Returnly User Password #{password}"
+              puts "Returnly User email #{returnly_email}"
+              puts "****************************************************"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solidus_returnly/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'solidus_returnly/factories'
+end

data/lib/solidus_returnly/refunds.rb

@@ -0,0 +1,81 @@
+module SolidusReturnly
+  class Refunds
+    attr_accessor :calculator, :order, :line_items, :restock, :transactions
+
+    def initialize(order:, line_items:, restock: true, transactions:)
+      self.order = order
+      self.line_items = line_items
+      self.calculator = Calculator.new order, line_items
+      self.restock = restock
+      self.transactions = transactions
+    end
+
+    def restock_return(customer_return)
+      customer_return.return_items.each do | item |
+        customer_return.stock_location.restock(item.inventory_unit.variant, 1, customer_return)
+      end
+    end
+
+    def proceed!
+      customer_return = Spree::CustomerReturn.new customer_return_params
+      customer_return.return_items = calculator.line_items_return_items.values.flatten
+
+      customer_return.return_items.each do |return_item|
+        return_item.amount = refund_amount_per_item
+      end
+
+      if customer_return.save!
+        reimbursement = perform_reimbursement(customer_return)
+        restock_return(customer_return) if self.restock
+
+        processed_customer_return(customer_return, reimbursement)
+      end
+    end
+
+    def processed_customer_return(customer_return, reimbursement)
+      {
+          refund_id: customer_return.number,
+          created_at: customer_return.created_at,
+          updated_at: customer_return.updated_at,
+          line_items: customer_return.return_items.map { |ri|
+            {
+                refund_line_item_id: ri.id,
+                order_line_item_id: ri.inventory_unit.line_item.id,
+                quantity: 1
+            }
+          },
+          transactions: [
+              id: reimbursement.id,
+              amount: reimbursement.total
+          ],
+          note: "comment text",
+          restock: true
+      }
+    end
+
+    def perform_reimbursement(customer_return)
+      reimbursement = Spree::Reimbursement.build_from_customer_return(customer_return)
+      reimbursement.save!
+      reimbursement.perform!
+      reimbursement
+    end
+
+    def customer_return_params
+      {
+          stock_location_id: stock_location_id,
+      }
+    end
+
+    def stock_location_id
+      order.shipments.last.stock_location.id
+    end
+
+    def refund_available_amount
+      @available_amount ||= self.transactions.sum{|t| Money.from_amount(t[:amount].to_f) }
+    end
+
+    def refund_amount_per_item
+      refund_available_amount / line_items.size
+    end
+  end
+end

data/lib/solidus_returnly/version.rb

@@ -0,0 +1,3 @@
+module SolidusReturnly
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,280 @@
+--- !ruby/object:Gem::Specification
+name: solidus-returnly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Returnly Technologies, Inc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: solidus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: solidus_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: solidus_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  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'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sass-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  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: Solidus API extensions for returnly
+email: support@returnly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/controllers/spree/api/refunds_controller.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/solidus_returnly/install/install_generator.rb
+- lib/solidus/returnly.rb
+- lib/solidus_returnly/calculator.rb
+- lib/solidus_returnly/engine.rb
+- lib/solidus_returnly/factories.rb
+- lib/solidus_returnly/refunds.rb
+- lib/solidus_returnly/version.rb
+homepage: https://github.com/returnly/solidus-returnly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Returnly integration with Solidus
+test_files: []