shiprocket_api 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9443675fd36232802cef16bf5c4105353594adc46dc13f31eb85088e6c005403
-  data.tar.gz: 2eb9395ca60960164123800c6519b5a2336d34cef8923842b16e9caf57d3a354
+  metadata.gz: daaeb47a98dc3ffd00727499089bb409b69e4675b2bde2cf4b8af03f47f88529
+  data.tar.gz: 3da69f20d46ae87a86442a104a1bbc7738996fe2b42fdd5a0a79dd80c550879f
 SHA512:
-  metadata.gz: bddf22356aec2bf2ffc168c1737b162ce8df328fc5dd8deebb3e1379c6bba24e8100382c39f9de9d51eea264bdbc28173f08928010fef9f66fe069afa6c25cc0
-  data.tar.gz: 0ab7edd322b605a323a5b1c25e18e306f8c7f8146973f7c04bed8616ea323c957c1e7cf7aed13e8351c9cd2a3ff738014fa475702570a37f60698818da2c8c99
+  metadata.gz: 8af0d4efaff52ee451c2ffe961e266400d680e755f871b63204bef4a4034a7d5fa2f324124264b720511a4424fa02d31ef57fdb0e145bc5b35bfe872ee53452f
+  data.tar.gz: 863d695ae42750b80296109f1a6fa07165ec718557e997c84929e0fc147dd0aeba422802799fc0ae006eeed77d63a54bb3c40dbd723eefa04df12bf1c1d8640f

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    shiprocket_api (0.4.0)
+    shiprocket_api (0.4.4)
       activeresource (~> 5.0)
       http
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.0)
-      activesupport (= 6.1.0)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
     activemodel-serializers-xml (1.0.2)
       activemodel (> 5.x)
       activesupport (> 5.x)
@@ -18,7 +18,7 @@ GEM
       activemodel (>= 5.0, < 7)
       activemodel-serializers-xml (~> 1.0)
       activesupport (>= 5.0, < 7)
-    activesupport (6.1.0)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -29,7 +29,7 @@ GEM
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.2)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.3)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
@@ -61,16 +61,16 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    http-parser (1.2.2)
-      ffi-compiler
-    i18n (1.8.5)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
     listen (3.2.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.4)
     method_source (1.0.0)
-    minitest (5.14.2)
+    minitest (5.14.4)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -101,7 +101,7 @@ GEM
     rspec-support (3.9.3)
     shellany (0.0.1)
     thor (1.0.1)
-    tzinfo (2.0.3)
+    tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext

data/lib/shiprocket_api.rb

@@ -1,17 +1,17 @@
-require "shiprocket_api/version"
-require "active_resource"
+require 'shiprocket_api/version'
+require 'active_resource'
 require 'http'
 
 module ShiprocketAPI
-
   require 'shiprocket_api/configuration'
   require 'shiprocket_api/connection'
   require 'shiprocket_api/errors'
 
+  require 'shiprocket_api/shared/order_helper'
+
   require 'shiprocket_api/resources/base'
   require 'shiprocket_api/resources/session'
   require 'shiprocket_api/resources/order_item'
-  require 'shiprocket_api/resources/custom_order'
   require 'shiprocket_api/resources/forward_shipment'
   require 'shiprocket_api/resources/pickup_location'
   require 'shiprocket_api/resources/channel'
@@ -19,6 +19,7 @@ module ShiprocketAPI
   require 'shiprocket_api/resources/tracking'
   require 'shiprocket_api/resources/label'
   require 'shiprocket_api/resources/pickup'
+  require 'shiprocket_api/resources/awb'
   require 'shiprocket_api/resources/return_order'
-  require 'shiprocket_api/resources/return_order/awb'
+  require 'shiprocket_api/resources/custom_order'
 end

data/lib/shiprocket_api/connection.rb

@@ -1,44 +1,42 @@
 module ShiprocketAPI
   class Connection < ActiveResource::Connection
-
     # override #get to handle get with body
     def get(path, headers = {}, body: nil)
       arguments = if body.nil?
-        [path, build_request_headers(headers, :get, self.site.merge(path))]
-      else
-        [path, body, build_request_headers(headers, :get, self.site.merge(path))]
-      end
+                    [path, build_request_headers(headers, :get, site.merge(path))]
+                  else
+                    [path, body, build_request_headers(headers, :get, site.merge(path))]
+                  end
       with_auth { request(:get, *arguments) }
     end
 
     def request(method, path, *arguments)
-
-      result = ActiveSupport::Notifications.instrument("request.active_resource") do |payload|
+      result = ActiveSupport::Notifications.instrument('request.active_resource') do |payload|
         payload[:method]      = method
         payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
         payload[:result]      = if method == :get && arguments.length == 2
-          HTTP.headers(arguments[1].symbolize_keys)
-            .get(payload[:request_uri], json: arguments[0])
-        else
-          http.send(method, path, *arguments)
-        end
+                                  HTTP.headers(arguments[1].symbolize_keys)
+                                      .get(payload[:request_uri], json: arguments[0])
+                                else
+                                  http.send(method, path, *arguments)
+                                end
         payload[:result]
       end
       handle_response(result)
     rescue Timeout::Error => e
-      raise ActiveResource::TimeoutError.new(e.message)
+      raise ActiveResource::TimeoutError, e.message
     rescue OpenSSL::SSL::SSLError => e
-      raise ActiveResource::SSLError.new(e.message)
+      raise ActiveResource::SSLError, e.message
     end
 
     # Handles response and error codes from the remote service.
     def handle_response(response)
       if response.code.to_i == 200 &&
-        JSON.parse(response.body).dig("message") || JSON.parse(response.body).dig("payload", "error_message")
-        raise CreationError.new(response)
+         JSON.parse(response.body)['message'] || JSON.parse(response.body).dig('payload', 'error_message')
+        raise CreationError, response
       else
         super
       end
     end
   end
-end
+end

data/lib/shiprocket_api/errors.rb

@@ -1,17 +1,16 @@
 module ShiprocketAPI
   class CreationError < ActiveResource::ConnectionError
-
     def data
-      JSON.parse(@response.body).dig("data", "data")      
+      JSON.parse(@response.body).dig('data', 'data')
     end
 
     def to_s
       response_json = JSON.parse(@response.body)
-      message = response_json.dig("message")
-      error_message = response_json.dig("payload", "error_message")
-      action = response_json.dig("payload", "action")
+      message = response_json.dig('message')
+      error_message = response_json.dig('payload', 'error_message')
+      action = response_json.dig('payload', 'action')
 
       message || "#{error_message} when #{action}"
     end
   end
-end
+end

data/lib/shiprocket_api/resources/awb.rb

@@ -0,0 +1,12 @@
+module ShiprocketAPI
+  class Awb < Base
+    self.prefix += '/courier/assign/awb'
+    self.element_name = ''
+
+    DEFAULT_ATTRS = {
+      shipment_id: 0,
+      courier_id: 0,
+      is_return: 0
+    }
+  end
+end

data/lib/shiprocket_api/resources/custom_order.rb

@@ -1,53 +1,52 @@
 module ShiprocketAPI
   class CustomOrder < Base
-    self.prefix += "/orders/create/adhoc"
-    self.element_name = ""
+    include Shared::OrderHelper
 
-    has_many :order_items, class_name: "ShiprocketAPI::OrderItem"
+    self.prefix += '/orders/create/adhoc'
+    self.element_name = ''
+
+    has_many :order_items, class_name: 'ShiprocketAPI::OrderItem'
 
     DEFAULT_ATTRS = {
-      order_id: "",
-      order_date: Date.today.strftime("%Y-%m-%d"),
-      pickup_location: "",
-      channel_id: "",
-      comment: "",
-      reseller_name: "",
-      company_name: "",
-      billing_customer_name: "",
-      billing_last_name: "",
-      billing_address: "",
-      billing_address_2: "",
-      billing_city: "",
-      billing_pincode: "",
-      billing_state: "",
-      billing_country: "",
-      billing_email: "",
-      billing_phone: "",
-      billing_alternate_phone: "",
+      order_id: '',
+      order_date: Date.today.strftime('%Y-%m-%d'),
+      pickup_location: '',
+      channel_id: '',
+      comment: '',
+      reseller_name: '',
+      company_name: '',
+      billing_customer_name: '',
+      billing_last_name: '',
+      billing_address: '',
+      billing_address_2: '',
+      billing_city: '',
+      billing_pincode: '',
+      billing_state: '',
+      billing_country: '',
+      billing_email: '',
+      billing_phone: '',
+      billing_alternate_phone: '',
       shipping_is_billing: true,
-      shipping_customer_name: "",
-      shipping_last_name: "",
-      shipping_address: "",
-      shipping_address_2: "",
-      shipping_city: "",
-      shipping_pincode: "",
-      shipping_country: "",
-      shipping_state: "",
-      shipping_email: "",
-      shipping_phone: "",
-      order_items: [ShiprocketAPI::OrderItem.new],
-      payment_method: "Prepaid",
-      shipping_charges: "",
-      giftwrap_charges: "",
-      transaction_charges: "",
-      total_discount: "",
-      sub_total: "",
-      length: "",
-      breadth: "",
-      height: "",
-      weight: "",
-      ewaybill_no: "",
-      customer_gstin: ""
+      order_items: [
+        ShiprocketAPI::OrderItem.new
+      ],
+      payment_method: 'Prepaid',
+      sub_total: '',
+      length: '',
+      breadth: '',
+      height: '',
+      weight: ''
     }
   end
-end
+
+  def generate_awb(courier_id:)
+    return false unless attributes['shipment_id'] && shipment_id != 0
+
+    self.awb = ::ShiprocketAPI::Awb.new(
+      shipment_id: shipment_id,
+      courier_id: courier_id,
+      is_return: 0
+    )
+    awb.save
+  end
+end

data/lib/shiprocket_api/resources/pickup.rb

@@ -4,9 +4,7 @@ module ShiprocketAPI
     self.element_name= ""
 
     DEFAULT_ATTRS = {
-      shipment_id: 0,
-      courier_id: 0,
-      is_return: 1
+      shipment_id: [0]
     }
   end
 end

data/lib/shiprocket_api/resources/pickup_location.rb

@@ -1,41 +1,40 @@
 module ShiprocketAPI
   class PickupLocation < Base
-    self.prefix += "/settings/company/addpickup"
-    self.element_name = ""
+    self.prefix += '/settings/company/addpickup'
+    self.element_name = ''
 
     class Collection < ActiveResource::Collection
       def initialize(parsed = {})
-        @elements = parsed["shipping_address"]
+        super
+        @elements = parsed['shipping_address']
       end
     end
     self.collection_parser = Collection
 
     DEFAULT_ATTRS = {
-      pickup_location: "",
-      name: "",
-      email: "",
-      phone: "",
-      address: "",
-      address_2: "",
-      city: "",
-      state: "",
-      country: "",
-      pin_code: ""
+      pickup_location: '',
+      name: '',
+      email: '',
+      phone: '',
+      address: '',
+      address_2: '',
+      city: '',
+      state: '',
+      country: '',
+      pin_code: ''
     }
 
     class << self
-
-      def set_prefix_to_list_all_locations
-        set_prefix("#{Base.prefix}/settings/company/pickup") do
-          yield
-        end
+      def set_prefix_to_list_all_locations(&block)
+        set_prefix("#{Base.prefix}/settings/company/pickup", &block)
       end
 
       def find_every(options)
         set_prefix_to_list_all_locations do
           prefix_options, query_options = split_options(options[:params])
           path = collection_path(prefix_options, query_options)
-          instantiate_collection((format.decode(connection.get(path, headers).body) || []), query_options, prefix_options)
+          instantiate_collection((format.decode(connection.get(path, headers).body) || []), query_options,
+                                 prefix_options)
         rescue ActiveResource::ResourceNotFound
           # Swallowing ResourceNotFound exceptions and return nil - as per
           # ActiveRecord.
@@ -44,11 +43,11 @@ module ShiprocketAPI
         end
       end
     end
-    
+
     def id_from_response(response)
-      JSON.parse(response.body).dig("address", "id")
+      JSON.parse(response.body).dig('address', 'id')
     rescue JSON::ParserError
       nil
     end
   end
-end
+end

data/lib/shiprocket_api/resources/return_order.rb

@@ -1,62 +1,77 @@
 module ShiprocketAPI
   class ReturnOrder < Base
-    self.prefix += "/orders/create/return"
-    self.element_name= ""
-    
+    include Shared::OrderHelper
+
+    self.prefix += '/orders/create/return'
+    self.element_name = ''
+
     DEFAULT_ATTRS = {
-      order_id: "",
-      order_date:  "",
-      channel_id: "",
-      pickup_customer_name: "",
-      pickup_last_name: "",
-      pickup_address: "",
-      pickup_address_2: "",
-      pickup_city: "",
-      pickup_state: "",
-      pickup_country: "",
-      pickup_pincode: "",
-      pickup_email: "",
-      pickup_phone: "",
-      pickup_isd_code: "",
-      pickup_location_id: "",
-      shipping_customer_name: "",
-      shipping_last_name: "",
-      shipping_address: "",
-      shipping_address_2: "",
-      shipping_city: "",
-      shipping_country: "",
-      shipping_pincode: "",
-      shipping_state: "",
-      shipping_email: "",
-      shipping_isd_code: "",
-      shipping_phone: "",
+      order_id: '',
+      order_date: '',
+      channel_id: '',
+      pickup_customer_name: '',
+      pickup_last_name: '',
+      pickup_address: '',
+      pickup_address_2: '',
+      pickup_city: '',
+      pickup_state: '',
+      pickup_country: '',
+      pickup_pincode: '',
+      pickup_email: '',
+      pickup_phone: '',
+      pickup_isd_code: '',
+      pickup_location_id: '',
+      shipping_customer_name: '',
+      shipping_last_name: '',
+      shipping_address: '',
+      shipping_address_2: '',
+      shipping_city: '',
+      shipping_country: '',
+      shipping_pincode: '',
+      shipping_state: '',
+      shipping_email: '',
+      shipping_isd_code: '',
+      shipping_phone: '',
       order_items: [
         ShiprocketAPI::OrderItem.new
       ],
-      payment_method: "",
-      total_discount: "",
-      sub_total: "",
-      length: "",
-      breadth: "",
-      height: "",
-      weight: ""
+      payment_method: 'Prepaid',
+      sub_total: '',
+      length: '',
+      breadth: '',
+      height: '',
+      weight: ''
     }
 
-    def generate_awb(courier_id:)
-      self.awb = Awb.create(
-        shipment_id: shipment_id,
-        courier_id: courier_id,
-        is_return: 1
-      )
+    class << self
+      def set_prefix_to_list_all(&block)
+        set_prefix("#{Base.prefix}/orders/processing/return", &block)
+      end
+
+      def find_every(options)
+        set_prefix_to_list_all do
+          prefix_options, query_options = split_options(options[:params])
+          path = collection_path(prefix_options, query_options)
+          instantiate_collection((format.decode(connection.get(path, headers).body)['data'] || []), query_options,
+                                 prefix_options)
+        rescue ActiveResource::ResourceNotFound
+          # Swallowing ResourceNotFound exceptions and return nil - as per
+          # ActiveRecord.
+          set_prefix_to_add
+          nil
+        end
+      end
     end
 
-    def create_pickup(courier_id:)
-      self.pickup = Pickup.create(
+    def generate_awb(courier_id:)
+      return false unless attributes['shipment_id'] && shipment_id != 0
+
+      self.awb = ::ShiprocketAPI::Awb.new(
         shipment_id: shipment_id,
         courier_id: courier_id,
         is_return: 1
       )
+      awb.save
     end
   end
 end
-  

data/lib/shiprocket_api/shared/order_helper.rb

@@ -0,0 +1,17 @@
+module Shared
+  module OrderHelper
+    def generate_label
+      return false unless attributes['shipment_id'] && shipment_id != 0
+
+      self.label = ::ShiprocketAPI::Label.new(shipment_id: [shipment_id])
+      label.save
+    end
+
+    def create_pickup
+      return false unless attributes['shipment_id'] && shipment_id != 0
+
+      self.pickup = ::ShiprocketAPI::Pickup.new(shipment_id: [shipment_id])
+      pickup.save
+    end
+  end
+end

data/lib/shiprocket_api/version.rb

@@ -1,3 +1,3 @@
 module ShiprocketAPI
-  VERSION = "0.4.1"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiprocket_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-02 00:00:00.000000000 Z
+date: 2021-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -133,6 +133,7 @@ files:
 - lib/shiprocket_api/configuration.rb
 - lib/shiprocket_api/connection.rb
 - lib/shiprocket_api/errors.rb
+- lib/shiprocket_api/resources/awb.rb
 - lib/shiprocket_api/resources/base.rb
 - lib/shiprocket_api/resources/channel.rb
 - lib/shiprocket_api/resources/courier_serviceability.rb
@@ -143,9 +144,9 @@ files:
 - lib/shiprocket_api/resources/pickup.rb
 - lib/shiprocket_api/resources/pickup_location.rb
 - lib/shiprocket_api/resources/return_order.rb
-- lib/shiprocket_api/resources/return_order/awb.rb
 - lib/shiprocket_api/resources/session.rb
 - lib/shiprocket_api/resources/tracking.rb
+- lib/shiprocket_api/shared/order_helper.rb
 - lib/shiprocket_api/version.rb
 - shiprocket_api.gemspec
 homepage: https://github.com/PostCo/sendle_api
@@ -171,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Ruby object based Sendle API wrapper.

data/lib/shiprocket_api/resources/return_order/awb.rb

@@ -1,18 +0,0 @@
-module ShiprocketAPI
-  class ReturnOrder::Awb < Base
-    self.prefix += "/courier/assign/awb"
-    self.element_name= ""
-
-    DEFAULT_ATTRS = {
-      shipment_id: 0,
-      courier_id: 0,
-      is_return: 1
-    }
-
-    def generate_label
-      return false unless self.attributes.shipment_id != 0
-
-      self.label= ::ShiprocketAPI::Label.create([shipment_id])
-    end
-  end
-end