shiprocket_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 122050eabae3accd1e92af9aa33f684b387d2b4e651ebf1f5128b0363a3169a7
+  data.tar.gz: 655b4d1fac605f8ac5a7535cf1b8308a5dd1ad1b06992a3eda1f484b2787f050
+SHA512:
+  metadata.gz: e7d35d6ec3ef05c2eb0959bc59d9bc4c521c6610db8157ccd77e44bc7865ded10ee81c9695035f6341285cf79b49a35dcb97f5116ac62ded34f574efc1ca7299
+  data.tar.gz: 4f67afabbee20217ac0cd24194a18a41f11bfba91271af3972a74620a55cebc768992e02dbe5492134d15c2c3c62175b3d66350d3fd0fdaf838c0a0a9303628e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.env
+.pryrc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andy_gg1996@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shiprocket_api.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,125 @@
+PATH
+  remote: .
+  specs:
+    shiprocket_api (0.1.0)
+      activeresource (~> 5.0)
+      http
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activemodel-serializers-xml (1.0.2)
+      activemodel (> 5.x)
+      activesupport (> 5.x)
+      builder (~> 3.1)
+    activeresource (5.1.1)
+      activemodel (>= 5.0, < 7)
+      activemodel-serializers-xml (~> 1.0)
+      activesupport (>= 5.0, < 7)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.6)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    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)
+    i18n (1.8.5)
+      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)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    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)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  guard-rspec
+  pry
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  shiprocket_api!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andy Chong
+
+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,98 @@
+# ShiprocketAPI
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shiprocket_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shiprocket_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install shiprocket_api
+
+## Usage
+
+```ruby
+ShiprocketAPI::ForwardShipment.new(
+        request_pickup: false,
+        print_label: true,
+        generate_manifest: true,
+        courier_id: 10,
+        order_id: "1235",
+        order_date: Date.today.strftime("%Y-%m-%d"),
+        pickup_location: "testing2",
+        billing_customer_name: "Andy Chong",
+        billing_last_name: "",
+        billing_address: "Salarpuria Symbiosis, Arekere Village, Begur, Bannerghatta Main Rd, Uttarahalli Hobli",
+        billing_address_2: "",
+        billing_city: "Bengaluru",
+        billing_pincode: "560076",
+        billing_state: "Karnataka",
+        billing_country: "India",
+        billing_email: "andy@postco.co",
+        billing_phone: 9223361686,
+        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(
+          name: "a book",
+          sku: "23232",
+          units: 1,
+          selling_price: 1234
+        )],
+        payment_method: "Prepaid",
+        sub_total: 1000,
+        length: 0.5,
+        breadth: 0.5,
+        height: 0.5,
+        weight: 0.5,
+        vendor_details: {
+          email: "andy@postco.co",
+          phone: "8888999888",
+          name: "Andy",
+          address: "C - 20, G Block Rd, G Block BKC, Bandra Kurla Complex, Bandra East",
+          address_2: "",
+          city: "Mumbai",
+          state: "Maharashtra",
+          country: "India",
+          pin_code: "400051",
+          pickup_location: "testing2"
+       })
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PostCo/shiprocket_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/PostCo/shiprocket_api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ShiprocketAPI project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/PostCo/shiprocket_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "dotenv/load"
+require "dev/zeitwerk_loader"
+require "dev/config"
+require "shiprocket_api"
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+set_config
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+require "pry-byebug"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here
+filename=".env"
+if [ ! -f $filename ]; then
+  touch $filename
+  echo "SHIPROCKET_API_USERNAME=" >>$filename
+  echo "SHIPROCKET_API_PASSWORD=" >>$filename
+fi
+
+filename=".pryrc"
+if [ ! -f $filename ]; then
+  touch $filename
+  echo "
+  Pry.commands.alias_command 'c', 'continue'
+  Pry.commands.alias_command 's', 'step'
+  Pry.commands.alias_command 'n', 'next'
+  Pry.commands.alias_command 'f', 'finish'
+  " >>$filename
+fi

data/lib/dev/config.rb

@@ -0,0 +1,8 @@
+require "dotenv/load"
+
+def set_config
+  ShiprocketAPI.configure do |config|
+    config.email = ENV["SHIPROCKET_API_USERNAME"] 
+    config.password = ENV["SHIPROCKET_API_PASSWORD"]
+  end
+end 

data/lib/dev/zeitwerk_loader.rb

@@ -0,0 +1,21 @@
+require "zeitwerk"
+require_relative "config"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "shiprocket_api" => "ShiprocketAPI"
+)
+loader.push_dir("./lib")
+loader.collapse("./lib/shiprocket_api/resources")
+loader.ignore("#{__dir__}/config.rb")
+loader.enable_reloading
+# loader.log!
+loader.setup
+
+$__shiprocket_api_loader__ = loader
+
+def reload!
+  $__shiprocket_api_loader__.reload
+  set_config
+  true
+end

data/lib/shiprocket_api.rb

@@ -0,0 +1,18 @@
+require "shiprocket_api/version"
+require "active_resource"
+require 'http'
+
+module ShiprocketAPI
+
+  require 'shiprocket_api/configuration'
+  require 'shiprocket_api/connection'
+
+  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'
+  require 'shiprocket_api/resources/courier_serviceability'
+end

data/lib/shiprocket_api/configuration.rb

@@ -0,0 +1,17 @@
+module ShiprocketAPI
+  class Configuration
+    attr_accessor :email, :password
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+  def self.config=(config)
+    @config = config
+  end
+
+  def self.configure
+    yield config
+  end
+end

data/lib/shiprocket_api/connection.rb

@@ -0,0 +1,34 @@
+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
+      with_auth { request(:get, *arguments) }
+    end
+
+    def request(method, path, *arguments)
+
+      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
+        payload[:result]
+      end
+      handle_response(result)
+    rescue Timeout::Error => e
+      raise ActiveResource::TimeoutError.new(e.message)
+    rescue OpenSSL::SSL::SSLError => e
+      raise ActiveResource::SSLError.new(e.message)
+    end
+  end
+end

data/lib/shiprocket_api/resources/base.rb

@@ -0,0 +1,32 @@
+module ShiprocketAPI
+  class Base < ActiveResource::Base
+    cattr_accessor :session
+
+    self.connection_class = ShiprocketAPI::Connection
+    self.include_root_in_json = false
+    self.include_format_in_path = false
+    self.site = "https://apiv2.shiprocket.in"
+    self.connection.auth_type = :bearer
+    self.prefix = '/v1/external'
+    self.session = nil
+
+    class << self
+      def create_session(email: ShiprocketAPI.config.email, password: ShiprocketAPI.config.password)
+        self.session = Session.create(email: email, password: password)
+        self.connection.bearer_token = session.token
+      end
+  
+      def clear_session
+        self.session = nil
+        self.connection.bearer_token = nil
+      end
+    end
+
+    def initialize(attributes = {}, persisted = false)
+      if defined?(self.class::DEFAULT_ATTRS)
+        attributes = self.class::DEFAULT_ATTRS.merge(attributes)
+      end
+      super
+    end
+  end
+end

data/lib/shiprocket_api/resources/channel.rb

@@ -0,0 +1,6 @@
+module ShiprocketAPI
+  class Channel < Base
+    self.prefix += "/channels"
+    self.element_name = ""
+  end
+end

data/lib/shiprocket_api/resources/courier_serviceability.rb

@@ -0,0 +1,35 @@
+module ShiprocketAPI
+  class CourierServiceability < Base
+    self.prefix += "/courier/serviceability"
+    self.element_name = ""
+
+    class Collection < ActiveResource::Collection
+      attr_accessor :is_recommendation_enabled,
+                    :recommended_by,
+                    :child_courier_id,
+                    :recommended_courier_company_id,
+                    :shiprocket_recommended_courier_id,
+                    :elements
+
+      def initialize(parsed = {})
+        @is_recommendation_enabled = parsed["data"]["is_recommendation_enabled"]
+        @recommended_by = parsed["data"]["recommended_by"]
+        @child_courier_id = parsed["data"]["child_courier_id"]
+        @recommended_courier_company_id = parsed["data"]["recommended_courier_company_id"]
+        @shiprocket_recommended_courier_id = parsed["data"]["shiprocket_recommended_courier_id"]
+        @elements = parsed["data"]["available_courier_companies"]
+      end
+    end
+
+    self.collection_parser = Collection
+
+    def self.find_every(options)
+      instantiate_collection(format.decode(connection.get(collection_path, headers, body: options[:params]).body) || [], options[:params])
+    rescue ActiveResource::ResourceNotFound
+      # Swallowing ResourceNotFound exceptions and return nil - as per
+      # ActiveRecord.
+      nil
+    end
+
+  end
+end

data/lib/shiprocket_api/resources/custom_order.rb

@@ -0,0 +1,55 @@
+module ShiprocketAPI
+  class CustomOrder < Base
+    self.prefix += "/orders/create/adhoc"
+    self.element_name = ""
+
+    has_many :order_items, class_name: "ShiprocketAPI::OrderItem"
+
+    DEFAULT_ATTRS = {
+      order_id: "1235",
+      order_date: Date.today.strftime("%Y-%m-%d"),
+      pickup_location: "test1",
+      channel_id: "",
+      comment: "",
+      reseller_name: "",
+      company_name: "",
+      billing_customer_name: "Andy Chong",
+      billing_last_name: "",
+      billing_address: "Salarpuria Symbiosis, Arekere Village, Begur, Bannerghatta Main Rd, Uttarahalli Hobli",
+      billing_address_2: "",
+      billing_city: "Bengaluru",
+      billing_pincode: "560076",
+      billing_state: "Karnataka",
+      billing_country: "India",
+      billing_email: "andy@postco.co",
+      billing_phone: 9223361686,
+      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: 1000,
+      length: 0.5,
+      breadth: 0.5,
+      height: 0.5,
+      weight: 0.5,
+      ewaybill_no: "",
+      customer_gstin: ""
+    }
+
+
+  end
+end

data/lib/shiprocket_api/resources/forward_shipment.rb

@@ -0,0 +1,71 @@
+module ShiprocketAPI
+  class ForwardShipment < Base
+    self.prefix += "/shipments/create/forward-shipment"
+    self.element_name = ""
+
+    DEFAULT_ATTRS = {
+      mode: "",
+      request_pickup: true,
+      print_label: true,
+      generate_manifest: "",
+      ewaybill_no: "",
+      courier_id: "",
+      reseller_name: "",
+      order_id: "",
+      isd_code: "",
+      billing_isd_code: "",
+      order_date: "",
+      channel_id: "",
+      company_name: "",
+      billing_customer_name: "",
+      billing_last_name: "",
+      billing_address: "",
+      billing_address_2: "",
+      billing_city: "",
+      billing_state: "",
+      billing_country: "",
+      billing_pincode: "",
+      billing_email: "",
+      billing_phone: "",
+      billing_alternate_phone: "",
+      shipping_is_billing: "",
+      shipping_customer_name: "",
+      shipping_last_name: "",
+      shipping_address: "",
+      shipping_address_2: "",
+      shipping_city: "",
+      shipping_state: "",
+      shipping_country: "",
+      shipping_pincode: "",
+      shipping_email: "",
+      shipping_phone: "",
+      order_items: [
+       ShiprocketAPI::OrderItem.new 
+      ],
+      payment_method: "",
+      shipping_charges: "",
+      giftwrap_charges: "",
+      transaction_charges: "",
+      total_discount: "",
+      sub_total: "",
+      weight: "",
+      length: "",
+      breadth: "",
+      height: "",
+      pickup_location: "",
+      customer_gstin: "",
+      vendor_details: {
+        email: "",
+        phone: "",
+        name: "",
+        address: "",
+        address_2: "",
+        city: "",
+        state: "",
+        country: "",
+        pin_code: "",
+        pickup_location: ""
+      }
+    }
+  end
+end

data/lib/shiprocket_api/resources/order_item.rb

@@ -0,0 +1,13 @@
+module ShiprocketAPI
+  class OrderItem < Base
+    DEFAULT_ATTRS = {
+      name: "",
+      sku: "",
+      units: 0,
+      selling_price: 0,
+      discount: "",
+      tax: "",
+      hsn: ""
+    }
+  end
+end

data/lib/shiprocket_api/resources/pickup_location.rb

@@ -0,0 +1,51 @@
+module ShiprocketAPI
+  class PickupLocation < Base
+    self.prefix += "/settings/company/addpickup"
+    self.element_name = ""
+
+    class Collection < ActiveResource::Collection
+      def initialize(parsed = {})
+        @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: ""
+    }
+
+    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
+      end
+
+      def find_every(options)
+        set_prefix_to_list 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)
+        rescue ActiveResource::ResourceNotFound
+          # Swallowing ResourceNotFound exceptions and return nil - as per
+          # ActiveRecord.
+          set_prefix_to_add
+          nil
+        end
+      end
+    end
+    
+    
+  end
+end

data/lib/shiprocket_api/resources/session.rb

@@ -0,0 +1,7 @@
+module ShiprocketAPI
+  class Session < Base
+    self.prefix += "/auth/login"
+    self.element_name = ""
+
+  end
+end

data/lib/shiprocket_api/version.rb

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

data/shiprocket_api.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/shiprocket_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shiprocket_api"
+  spec.version       = ShiprocketAPI::VERSION
+  spec.authors       = ["Andy Chong"]
+  spec.email         = ["andygg1996personal@gmail.com"]
+
+  spec.summary       = "Ruby object based Sendle API wrapper."
+  spec.homepage      = "https://github.com/PostCo/sendle_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/PostCo/shiprocket_api"
+  spec.metadata["changelog_uri"] = "https://github.com/PostCo/shiprocket_api/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activeresource", "~> 5.0"
+  spec.add_dependency "http"
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "guard-rspec"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: shiprocket_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andy Chong
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: pry-byebug
+  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: pry
+  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: guard-rspec
+  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:
+email:
+- andygg1996personal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/dev/config.rb
+- lib/dev/zeitwerk_loader.rb
+- lib/shiprocket_api.rb
+- lib/shiprocket_api/configuration.rb
+- lib/shiprocket_api/connection.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/order_item.rb
+- lib/shiprocket_api/resources/pickup_location.rb
+- lib/shiprocket_api/resources/session.rb
+- lib/shiprocket_api/version.rb
+- shiprocket_api.gemspec
+homepage: https://github.com/PostCo/sendle_api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/PostCo/sendle_api
+  source_code_uri: https://github.com/PostCo/shiprocket_api
+  changelog_uri: https://github.com/PostCo/shiprocket_api/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Ruby object based Sendle API wrapper.
+test_files: []