shiprocket_api 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 122050eabae3accd1e92af9aa33f684b387d2b4e651ebf1f5128b0363a3169a7
-  data.tar.gz: 655b4d1fac605f8ac5a7535cf1b8308a5dd1ad1b06992a3eda1f484b2787f050
+  metadata.gz: 9443675fd36232802cef16bf5c4105353594adc46dc13f31eb85088e6c005403
+  data.tar.gz: 2eb9395ca60960164123800c6519b5a2336d34cef8923842b16e9caf57d3a354
 SHA512:
-  metadata.gz: e7d35d6ec3ef05c2eb0959bc59d9bc4c521c6610db8157ccd77e44bc7865ded10ee81c9695035f6341285cf79b49a35dcb97f5116ac62ded34f574efc1ca7299
-  data.tar.gz: 4f67afabbee20217ac0cd24194a18a41f11bfba91271af3972a74620a55cebc768992e02dbe5492134d15c2c3c62175b3d66350d3fd0fdaf838c0a0a9303628e
+  metadata.gz: bddf22356aec2bf2ffc168c1737b162ce8df328fc5dd8deebb3e1379c6bba24e8100382c39f9de9d51eea264bdbc28173f08928010fef9f66fe069afa6c25cc0
+  data.tar.gz: 0ab7edd322b605a323a5b1c25e18e306f8c7f8146973f7c04bed8616ea323c957c1e7cf7aed13e8351c9cd2a3ff738014fa475702570a37f60698818da2c8c99

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    shiprocket_api (0.1.0)
+    shiprocket_api (0.4.0)
       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/dev/zeitwerk_loader.rb

@@ -8,6 +8,7 @@ loader.inflector.inflect(
 loader.push_dir("./lib")
 loader.collapse("./lib/shiprocket_api/resources")
 loader.ignore("#{__dir__}/config.rb")
+loader.ignore("./lib/shiprocket_api/errors.rb")
 loader.enable_reloading
 # loader.log!
 loader.setup

data/lib/shiprocket_api.rb

@@ -6,6 +6,7 @@ module ShiprocketAPI
 
   require 'shiprocket_api/configuration'
   require 'shiprocket_api/connection'
+  require 'shiprocket_api/errors'
 
   require 'shiprocket_api/resources/base'
   require 'shiprocket_api/resources/session'
@@ -15,4 +16,9 @@ module ShiprocketAPI
   require 'shiprocket_api/resources/pickup_location'
   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

@@ -30,5 +30,15 @@ module ShiprocketAPI
     rescue OpenSSL::SSL::SSLError => e
       raise ActiveResource::SSLError.new(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)
+      else
+        super
+      end
+    end
   end
 end

data/lib/shiprocket_api/errors.rb

@@ -0,0 +1,17 @@
+module ShiprocketAPI
+  class CreationError < ActiveResource::ConnectionError
+
+    def 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 || "#{error_message} when #{action}"
+    end
+  end
+end

data/lib/shiprocket_api/resources/base.rb

@@ -20,6 +20,22 @@ module ShiprocketAPI
         self.session = nil
         self.connection.bearer_token = nil
       end
+
+      def with_temp_session(email:, password:, &block)
+        raise ArgumentError, "A block must be given" unless block
+
+        create_session(email: email, password: password)
+        yield
+        clear_session
+      end
+
+      def set_prefix(prefix)
+        ori_prefix = self.prefix
+        self.prefix = prefix
+        result = yield
+        self.prefix = ori_prefix
+        result
+      end
     end
 
     def initialize(attributes = {}, persisted = false)

data/lib/shiprocket_api/resources/custom_order.rb

@@ -6,23 +6,23 @@ module ShiprocketAPI
     has_many :order_items, class_name: "ShiprocketAPI::OrderItem"
 
     DEFAULT_ATTRS = {
-      order_id: "1235",
+      order_id: "",
       order_date: Date.today.strftime("%Y-%m-%d"),
-      pickup_location: "test1",
+      pickup_location: "",
       channel_id: "",
       comment: "",
       reseller_name: "",
       company_name: "",
-      billing_customer_name: "Andy Chong",
+      billing_customer_name: "",
       billing_last_name: "",
-      billing_address: "Salarpuria Symbiosis, Arekere Village, Begur, Bannerghatta Main Rd, Uttarahalli Hobli",
+      billing_address: "",
       billing_address_2: "",
-      billing_city: "Bengaluru",
-      billing_pincode: "560076",
-      billing_state: "Karnataka",
-      billing_country: "India",
-      billing_email: "andy@postco.co",
-      billing_phone: 9223361686,
+      billing_city: "",
+      billing_pincode: "",
+      billing_state: "",
+      billing_country: "",
+      billing_email: "",
+      billing_phone: "",
       billing_alternate_phone: "",
       shipping_is_billing: true,
       shipping_customer_name: "",
@@ -41,15 +41,13 @@ module ShiprocketAPI
       giftwrap_charges: "",
       transaction_charges: "",
       total_discount: "",
-      sub_total: 1000,
-      length: 0.5,
-      breadth: 0.5,
-      height: 0.5,
-      weight: 0.5,
+      sub_total: "",
+      length: "",
+      breadth: "",
+      height: "",
+      weight: "",
       ewaybill_no: "",
       customer_gstin: ""
     }
-
-
   end
 end

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

@@ -24,16 +24,15 @@ module ShiprocketAPI
     }
 
     class << self
-      def set_prefix_to_list
-        ori_prefix = self.prefix
-        self.prefix = self.prefix.split("/")[0..-2].append("pickup").join("/")        
-        result = yield
-        self.prefix = ori_prefix
-        result
+
+      def set_prefix_to_list_all_locations
+        set_prefix("#{Base.prefix}/settings/company/pickup") do
+          yield
+        end
       end
 
       def find_every(options)
-        set_prefix_to_list do
+        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)
@@ -46,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,62 @@
+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: ""
+    }
+
+    def generate_awb(courier_id:)
+      self.awb = Awb.create(
+        shipment_id: shipment_id,
+        courier_id: courier_id,
+        is_return: 1
+      )
+    end
+
+    def create_pickup(courier_id:)
+      self.pickup = Pickup.create(
+        shipment_id: shipment_id,
+        courier_id: courier_id,
+        is_return: 1
+      )
+    end
+  end
+end
+  

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

@@ -0,0 +1,18 @@
+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

data/lib/shiprocket_api/resources/tracking.rb

@@ -0,0 +1,16 @@
+module ShiprocketAPI
+  class Tracking < Base
+    self.prefix += "/courier/track/awb"
+    self.element_name = ""
+    
+    class << self
+
+      def find_by_shipment_id(id)
+        set_prefix("#{Base.prefix}/courier/track/shipment") do
+          find(id)
+        end
+      end
+
+    end
+  end
+end

data/lib/shiprocket_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shiprocket_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-22 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
@@ -131,14 +132,20 @@ files:
 - lib/shiprocket_api.rb
 - lib/shiprocket_api/configuration.rb
 - lib/shiprocket_api/connection.rb
+- lib/shiprocket_api/errors.rb
 - lib/shiprocket_api/resources/base.rb
 - lib/shiprocket_api/resources/channel.rb
 - 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
 - shiprocket_api.gemspec
 homepage: https://github.com/PostCo/sendle_api