cm_clickpost 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77a7d42124bb9b21c709fe046cd0d033d412eee61eba14ae29f4e9cf31438ea4
+  data.tar.gz: 5623e7be27011aa6b34ab1da53ea3ee72c90893e741c92306a061a1574f9cb4e
+SHA512:
+  metadata.gz: f2e26ced3b18acce9fe80bb9a58e7495742314491feef492b88781005a2fe35729ecae3919d13f78f0c114ec4ecc5e2e25cad27c5330bd70d8fc38100ea784c8
+  data.tar.gz: 74aea3248db9b4e0b5223c642161d66018c6635270788b07ad6fb602f699e1566ef92037eb3f294fa17f8a2391f275141218eb646e3987d956fc01d5f14acdbe

data/README.md

@@ -0,0 +1,43 @@
+# CmClickpost
+
+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/cm_clickpost`. 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 'cm_clickpost'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cm_clickpost
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/[USERNAME]/cm_clickpost. 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/[USERNAME]/cm_clickpost/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 CmClickpost project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/cm_clickpost/blob/master/CODE_OF_CONDUCT.md).

data/lib/cm_clickpost/additional_info.rb

@@ -0,0 +1,12 @@
+module CmClickpost
+    class AdditionalInfo < CmClickpost::BasePayload
+        @@attributes = [
+                :label, :awb_number, :delivery_type, :async,
+                :gst_number, :account_code, :order_date, :is_fragile, 
+                :is_dangerous, :order_id
+            ]
+
+        define_class_methods(@@attributes, @attributes)
+
+    end
+end

data/lib/cm_clickpost/api_version.rb

@@ -0,0 +1,8 @@
+module ApiVersion
+    API_VERSIONS = {
+        create_order: 'v3',
+        track_order: 'v2',
+        predicted_sla_api: 'v2',
+        serviceability_api: 'v1'
+      }
+end

data/lib/cm_clickpost/base_payload.rb

@@ -0,0 +1,23 @@
+module CmClickpost
+    class BasePayload
+
+    
+      def self.define_class_methods(fields, attributes)
+        fields.each do |field|
+          define_method(field) do
+            attributes[field]
+          end
+
+          define_method("#{field}=") do |value|
+            attributes[field] = value
+          end
+        end
+      
+      end
+
+      def initialize(attributes = {})
+        @attributes = attributes
+      end
+    
+    end
+  end

data/lib/cm_clickpost/concerns/helpers.rb

@@ -0,0 +1,13 @@
+module CmClickpost
+  module Concerns
+    module Helpers
+      extend ActiveSupport::Concern
+      included do
+        def convert_to_json(data)
+          return data.as_json.map {|a| a['attributes'].with_indifferent_access } if data.instance_of? (Array)
+          data.as_json['attributes'].with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/cm_clickpost/configuration.rb

@@ -0,0 +1,11 @@
+module CmClickpost
+    class Configuration
+      attr_accessor :api_key, :username, :environment
+  
+      def initialize(username, api_key, environment)
+        @username = username
+        @api_key = api_key
+        @environment = environment
+      end
+    end
+  end

data/lib/cm_clickpost/drop_address.rb

@@ -0,0 +1,11 @@
+module CmClickpost
+    class DropAddress < CmClickpost::BasePayload
+        @@attributes = [
+            :drop_state, :drop_address, :drop_email, 
+            :drop_pincode, :drop_city, :drop_phone, :drop_country, :drop_name
+        ]
+
+        define_class_methods(@@attributes, @attributes)
+
+    end
+end

data/lib/cm_clickpost/gst_info.rb

@@ -0,0 +1,12 @@
+module CmClickpost
+    class GstInfo < CmClickpost::BasePayload
+        @@attributes = [
+            :seller_gstin, :taxable_value, :is_seller_registered_under_gst, 
+            :place_of_supply, :hsn_code, :enterprise_gstin, :gst_total_tax, 
+            :igst_amount, :cgst_amount, :consignee_gstin, :invoice_reference
+        ]
+
+        define_class_methods(@@attributes, @attributes)
+
+    end
+end

data/lib/cm_clickpost/order.rb

@@ -0,0 +1,12 @@
+module CmClickpost
+    class Order < CmClickpost::BasePayload
+        @@attributes = [
+            :height, :length, :breadth, :weight, 
+            :cod_value, :courier_partner, :order_type, :invoice_value, 
+            :invoice_number, :invoice_date, :reference_number
+        ]
+
+        define_class_methods(@@attributes, @attributes)
+
+    end
+end

data/lib/cm_clickpost/pickup_address.rb

@@ -0,0 +1,14 @@
+module CmClickpost
+    class PickupAddress < CmClickpost::BasePayload
+        @@attributes = [
+            :pickup_state, :pickup_address, :email, 
+            :pickup_time, :pickup_pincode, :pickup_city, :tin, 
+            :pickup_phone, :pickup_country, :pickup_name
+        ]
+
+        
+        define_class_methods(@@attributes, @attributes)
+
+
+    end
+end

data/lib/cm_clickpost/product_info.rb

@@ -0,0 +1,8 @@
+module CmClickpost
+    class ProductInfo < CmClickpost::BasePayload
+        @@attributes = [:product_url, :price, :description, :additional, :quantity, :sku]
+
+        define_class_methods(@@attributes, @attributes)
+
+    end
+end

data/lib/cm_clickpost/return_address.rb

@@ -0,0 +1,8 @@
+module CmClickpost
+    class ReturnAddress < CmClickpost::BasePayload
+        @@attributes = [:state, :address, :pincode, :city, :phone, :country, :name]
+
+        define_class_methods(@@attributes, @attributes)
+
+    end
+end

data/lib/cm_clickpost/shipment.rb

@@ -0,0 +1,78 @@
+module CmClickpost
+  class Shipment
+    attr_accessor :pickup_address, :drop_address, :order_details, :product_details, :products, :gst_info, :additional_info, :return_address
+    include CmClickpost::Concerns::Helpers
+
+    def initialize
+      @pickup_address = nil
+      @drop_address = nil
+      @order_details = nil
+      @product_details = nil
+      @products = []
+      @gst_info = nil
+      @additional_info = nil
+      @return_address = nil
+    end
+
+    def pickup_address(**args)
+      @pickup_address = CmClickpost::PickupAddress.new(args) if args.present?
+      @pickup_address
+    end
+
+    def drop_address(**args)
+      @drop_address = CmClickpost::DropAddress.new(args) if args.present?
+      @drop_address
+    end
+
+    def order_details(**args)
+      @order_details = CmClickpost::Order.new(args) if args.present?
+      @order_details
+    end
+
+    def product_details(**args)
+      if args.present?
+        @product_details = CmClickpost::ProductInfo.new(args) 
+        @products << @product_details
+        return @product_details
+      end
+      @products
+    end
+
+    def gst_info(**args)
+      @gst_info = CmClickpost::GstInfo.new(args) if args.present?
+      @gst_info
+    end
+
+    def additional_info(**args)
+      @additional_info = CmClickpost::AdditionalInfo.new(args) if args.present?
+      @additional_info
+    end
+
+    def return_address(**args)
+      @return_address = CmClickpost::ReturnAddress.new(args) if args.present?
+      @return_address
+    end
+
+    def self.track(waybill:, courier_partner_id:)
+      additional_params = "&waybill=#{waybill}&cp_id=#{courier_partner_id}"
+      CmClickpost.send_request(method: 'get', route_param: '/track-order/', api_version: ApiVersion::API_VERSIONS[:track_order], additional_params: additional_params)
+    end
+
+    def create_shipping_order
+      shipment_details = convert_to_json(@order_details)
+      shipment_details.store(:items, convert_to_json(@products))
+
+      additional = convert_to_json(@additional_info)
+      additional.store(:return_info, convert_to_json(@return_address))
+
+      request_payload = {
+        "pickup_info": convert_to_json(@pickup_address),
+        "drop_info": convert_to_json(@drop_address),
+        "shipment_details": shipment_details,
+        "gst_info": convert_to_json(@gst_info),
+        "additional": additional
+      }
+      CmClickpost.send_request(route_param: '/create-order/', api_version: ApiVersion::API_VERSIONS[:create_order], request_payload: request_payload)
+    end
+  end
+end

data/lib/cm_clickpost/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CmClickpost
+  VERSION = "0.1.0"
+end

data/lib/cm_clickpost.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "cm_clickpost/base_payload"
+require_relative "cm_clickpost/version"
+require_relative 'cm_clickpost/configuration'
+require_relative 'cm_clickpost/api_version'
+require_relative 'cm_clickpost/concerns/helpers.rb'
+require_relative 'cm_clickpost/pickup_address'
+require_relative 'cm_clickpost/shipment'
+require_relative "cm_clickpost/drop_address"
+require_relative "cm_clickpost/order"
+require_relative "cm_clickpost/product_info"
+require_relative "cm_clickpost/gst_info"
+require_relative "cm_clickpost/additional_info"
+require_relative "cm_clickpost/return_address"
+
+# Dir["../cm_clickpost/lib/cm_clickpost/concerns/*.rb"].each { |file| require file }
+# Dir["../cm_clickpost/lib/cm_clickpost/*.rb"].each { |file| require file }
+
+
+
+
+module CmClickpost
+  class << self
+    include CmClickpost::Concerns::Helpers
+
+    attr_accessor :configuration, :pickup_address
+    require 'net/http'
+    require 'uri'
+    require 'json'
+
+    BASE_URL = "https://www.clickpost.in/api/"
+
+    def setup(username, api_key, environment)
+      @configuration ||= Configuration.new(username, api_key, environment)
+    end
+    
+
+    def send_request(method: 'post', route_param:, api_version: '', request_payload: '', additional_params: '')
+      query_params = "/?username=#{@configuration.username}&key=#{@configuration.api_key}"
+      uri = URI.parse(BASE_URL + api_version + route_param  + query_params + additional_params)
+      headers = {'Content-Type': 'application/json' }
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = "Net::HTTP::#{method.classify}".constantize.new(uri.request_uri, headers)
+      request.body = request_payload.to_json
+      response = http.request(request)
+      result = JSON.parse(response.body)
+      if result['meta']['success'] == true
+        return result
+      else
+        raise Exception.new result['meta']['message']
+      end
+    end
+
+  end 
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: cm_clickpost
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jishnu De Sarkar
+- Aditya Tiwari
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-07 00:00:00.000000000 Z
+dependencies: []
+description: Clickpost wrapper
+email:
+- jishnu@commutatus.com
+- taditya.tiwari007@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/cm_clickpost.rb
+- lib/cm_clickpost/additional_info.rb
+- lib/cm_clickpost/api_version.rb
+- lib/cm_clickpost/base_payload.rb
+- lib/cm_clickpost/concerns/helpers.rb
+- lib/cm_clickpost/configuration.rb
+- lib/cm_clickpost/drop_address.rb
+- lib/cm_clickpost/gst_info.rb
+- lib/cm_clickpost/order.rb
+- lib/cm_clickpost/pickup_address.rb
+- lib/cm_clickpost/product_info.rb
+- lib/cm_clickpost/return_address.rb
+- lib/cm_clickpost/shipment.rb
+- lib/cm_clickpost/version.rb
+homepage: https://github.com/commutatus/cm_clickpost
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/commutatus/cm_clickpost
+  source_code_uri: https://github.com/commutatus/cm_clickpost
+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.3.7
+signing_key:
+specification_version: 4
+summary: Clickpost API integration
+test_files: []