shiprocket_api 0.3.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c057099ffcbca01d9bd58bc897b1c4fabc88ba62829936265fae8501fe878eb1
-  data.tar.gz: 9181af583fd91e33238fc6ea455eef127493a94297efcebda5ec58514de46265
+  metadata.gz: 1e55a3ebda672952872f26c745bc366c00ddad9f431535df333a542768a685d8
+  data.tar.gz: 2f4e70f857c0388cf03eb52a3844fdac59f5c84f3e7955fbc3f4b40ec1012d12
 SHA512:
-  metadata.gz: 6c07cca3490315c4c51dfde8a58bac0230468e7d6f958f0e4c858cb06b64e360877aefbece413c1b43fca23fe5b94bb019c981a168c13d519aa5acbe9495b87d
-  data.tar.gz: 54d5ff95903c61046d096f711dad7058c6bcc3e9d3ee7fbcee7391b9a8cfbdfa2a8df6b897c665b7e921322111123a8c4623c0f56d038984d2b00e4a6afafcef
+  metadata.gz: 8b9703cef3013af7bd5e9a76b7b59c4d8c036edaed872b32245d745a9203f97365d7010e9f43b65be48114e32f000e4c204f2987ae60ce59e482d27cf939b4f2
+  data.tar.gz: 3a8b58fd4c08838c3138b23fe98ec3c9e1df60205492004b2580ceaa463d3228c9e9719687f87671e5e3b358766c297fa19fc9b655177ae70d6a831762aa2c89

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    shiprocket_api (0.2.0)
+    shiprocket_api (0.4.2)
       activeresource (~> 5.0)
       http
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.3.4)
-      activesupport (= 6.0.3.4)
+    activemodel (6.1.0)
+      activesupport (= 6.1.0)
     activemodel-serializers-xml (1.0.2)
       activemodel (> 5.x)
       activesupport (> 5.x)
@@ -18,12 +18,12 @@ GEM
       activemodel (>= 5.0, < 7)
       activemodel-serializers-xml (~> 1.0)
       activesupport (>= 5.0, < 7)
-    activesupport (6.0.3.4)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     builder (3.2.4)
@@ -61,8 +61,8 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    http-parser (1.2.1)
-      ffi-compiler (>= 1.0, < 2.0)
+    http-parser (1.2.2)
+      ffi-compiler
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     listen (3.2.1)
@@ -101,13 +101,12 @@ GEM
     rspec-support (3.9.3)
     shellany (0.0.1)
     thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.3)
+      concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/lib/shiprocket_api.rb

@@ -17,5 +17,8 @@ module ShiprocketAPI
   require 'shiprocket_api/resources/channel'
   require 'shiprocket_api/resources/courier_serviceability'
   require 'shiprocket_api/resources/tracking'
-
+  require 'shiprocket_api/resources/label'
+  require 'shiprocket_api/resources/pickup'
+  require 'shiprocket_api/resources/return_order'
+  require 'shiprocket_api/resources/return_order/awb'
 end

data/lib/shiprocket_api/connection.rb

@@ -33,7 +33,8 @@ module ShiprocketAPI
 
     # Handles response and error codes from the remote service.
     def handle_response(response)
-      if response.code.to_i == 200 && JSON.parse(response.body).keys.include?("message")
+      if response.code.to_i == 200 &&
+        JSON.parse(response.body).dig("message") || JSON.parse(response.body).dig("payload", "error_message")
         raise CreationError.new(response)
       else
         super

data/lib/shiprocket_api/errors.rb

@@ -6,7 +6,12 @@ module ShiprocketAPI
     end
 
     def to_s
-      JSON.parse(@response.body)["message"]
+      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 || "#{error_message} when #{action}"
     end
   end
 end

data/lib/shiprocket_api/resources/base.rb

@@ -29,9 +29,9 @@ module ShiprocketAPI
         clear_session
       end
 
-      def set_resource(resource)
+      def set_prefix(prefix)
         ori_prefix = self.prefix
-        self.prefix = self.prefix.split("/")[0..-2].append(resource).join("/")        
+        self.prefix = prefix
         result = yield
         self.prefix = ori_prefix
         result

data/lib/shiprocket_api/resources/label.rb

@@ -0,0 +1,11 @@
+module ShiprocketAPI
+  class Label < Base
+    self.prefix += "/courier/generate/label"
+    self.element_name= ""
+
+    DEFAULT_ATTRS = {
+      shipment_id: [0]
+    }
+
+  end
+end

data/lib/shiprocket_api/resources/pickup.rb

@@ -0,0 +1,13 @@
+module ShiprocketAPI
+  class Pickup < Base
+    self.prefix += "/courier/generate/pickup"
+    self.element_name= ""
+
+    DEFAULT_ATTRS = {
+      shipment_id: 0,
+      courier_id: 0,
+      is_return: 1
+    }
+  end
+end
+

data/lib/shiprocket_api/resources/pickup_location.rb

@@ -26,7 +26,7 @@ module ShiprocketAPI
     class << self
 
       def set_prefix_to_list_all_locations
-        set_resource('pickup') do
+        set_prefix("#{Base.prefix}/settings/company/pickup") do
           yield
         end
       end
@@ -45,6 +45,10 @@ module ShiprocketAPI
       end
     end
     
-    
+    def id_from_response(response)
+      JSON.parse(response.body).dig("address", "id")
+    rescue JSON::ParserError
+      nil
+    end
   end
 end

data/lib/shiprocket_api/resources/return_order.rb

@@ -0,0 +1,93 @@
+module ShiprocketAPI
+  class ReturnOrder < Base
+    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_items: [
+        ShiprocketAPI::OrderItem.new
+      ],
+      payment_method: "",
+      total_discount: "",
+      sub_total: "",
+      length: "",
+      breadth: "",
+      height: "",
+      weight: ""
+    }
+
+    class << self
+
+      def set_prefix_to_list_all
+        set_prefix("#{Base.prefix}/orders/processing/return") do
+          yield
+        end
+      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 generate_awb(courier_id:)
+      self.awb = Awb.new(
+        shipment_id: shipment_id,
+        courier_id: courier_id,
+        is_return: 1
+      )
+      self.awb.save
+    end
+
+    def generate_label
+      return false unless respond_to?(:shipment_id) && shipment_id != 0
+
+      self.label = ::ShiprocketAPI::Label.new(shipment_id: [shipment_id])
+      self.label.save
+    end
+
+    def create_pickup(courier_id:)
+      self.pickup = ::ShiprocketAPI::Pickup.new(
+        shipment_id: shipment_id,
+        courier_id: courier_id,
+        is_return: 1
+      )
+      self.pickup.save
+    end
+  end
+end
+  

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

@@ -0,0 +1,12 @@
+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
+    }
+  end
+end

data/lib/shiprocket_api/resources/tracking.rb

@@ -6,7 +6,7 @@ module ShiprocketAPI
     class << self
 
       def find_by_shipment_id(id)
-        set_resource('shipment') do
+        set_prefix("#{Base.prefix}/courier/track/shipment") do
           find(id)
         end
       end

data/lib/shiprocket_api/version.rb

@@ -1,3 +1,3 @@
 module ShiprocketAPI
-  VERSION = "0.3.0"
+  VERSION = "0.4.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiprocket_api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-30 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeresource
@@ -121,6 +121,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -137,8 +138,12 @@ files:
 - lib/shiprocket_api/resources/courier_serviceability.rb
 - lib/shiprocket_api/resources/custom_order.rb
 - lib/shiprocket_api/resources/forward_shipment.rb
+- lib/shiprocket_api/resources/label.rb
 - lib/shiprocket_api/resources/order_item.rb
+- 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/version.rb