eshipper 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 430bd6453ae77295e5e46c31e7f2e5c336d9c49de930f5e45f89df5b475b1e1f
+  data.tar.gz: 06023bb5db1fddaa9087fb8071e99f45d6f0574172bdc5781e86e22723583bc7
+SHA512:
+  metadata.gz: 7e3a4ec1dd8230490dfa716d4ed9eae3cbf9769c2d10f5e6b1b8c5023aa679e4225d3ce55a1e780a842da5e7f2dde4b344a369c4efe1936e65612b013f1ff709
+  data.tar.gz: 98cb1ce593bbe3d435829d0e67caf0de47f761122a34659960f63a3358cb3ffe2c610ffb08a653b1d844fb228b3c75909863c95bdb5ab8d99b58c07260e81d02

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+coverage/

data/.rubocop.yml

@@ -0,0 +1,20 @@
+##
+# .rubocop.yml
+
+require:
+  - rubocop-rails
+
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7.6
+
+Naming/VariableName:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Rails:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gem "pry-byebug"
+gem "rubocop"
+gem "rubocop-rails", require: false
+gem "rubocop-shopify", require: false
+gem "activeresource"
+
+# Specify your gem's dependencies in eshipper.gemspec
+gemspec

data/eshipper.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+require File.expand_path("../lib/eshipper/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "eshipper"
+  gem.version       = EShipperRuby::VERSION
+  gem.authors       = ["Marc 🐝", "Daniel Gonzalez", "Chris Wise", "Damien Imberdis"]
+  gem.email         = ["hello@inventory.horse"]
+  gem.description   = "eShipper API client"
+  gem.summary       = "eShipper API wrapper for Ruby using ActiveResource"
+  gem.homepage      = "https://github.com/hrdwdmrbl/eshipper"
+  gem.licenses      = ["MIT"]
+
+  gem.files         = %x(git ls-files).split($/)
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency("activeresource")
+  gem.add_dependency("nokogiri")
+end

data/lib/eshipper/classes/order.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module EShipper
+  class Order < EShipperResponse
+    def self.search(options = {})
+      orders = SearchReply.search(options).OrderSearchReply.Order
+      orders.is_a?(Array) ? orders : [orders]
+    end
+
+    def fetch
+      OrderInformationReply.fetch(order_id: self.Id).OrderInformationReply
+    end
+  end
+end

data/lib/eshipper/client.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module EShipper
+  class Client
+    include Singleton
+
+    attr_reader :url
+    attr_accessor :username, :password
+
+    def initialize
+      @url = "https://web.eshipper.com/rpc2"
+    end
+  end
+end

data/lib/eshipper/requests/order_information_request.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module EShipper
+  class OrderInformationRequest < EShipper::Request
+    attr_reader :order_id
+
+    def initialize(order_id:)
+      @order_id = order_id
+      super()
+    end
+
+    def order_properties
+      {
+        orderId: @order_id,
+        detailed: "true",
+      }
+    end
+
+    def request_body
+      builder = build do |xml|
+        xml.OrderInformationRequest do
+          xml.Order(order_properties)
+        end
+      end
+      builder.to_xml
+    end
+  end
+end

data/lib/eshipper/requests/order_search_request.rb

@@ -0,0 +1,60 @@
+require "date"
+
+module EShipper
+  class OrderSearchRequest < EShipper::Request
+    attr_reader :fromDate
+    attr_reader :toDate
+    attr_reader :carrierId
+    attr_reader :statusId
+    attr_reader :startOrderId
+    attr_reader :endOrderId
+    attr_reader :carrierTrackingNumber
+    attr_reader :referenceValue
+
+    def initialize(
+      fromDate: Date.today - 90, # [Required]
+      toDate: Date.today, # [Required]
+      carrierId: nil, # [Optional]
+      statusId: nil, # [Optional]
+      startOrderId: nil, # [Optional]
+      endOrderId: nil, # [Optional]
+      carrierTrackingNumber: nil, # [Optional]
+      referenceValue: nil # [Optional]
+    )
+      throw("Order date range should be within 3 month.") if toDate - 90 > fromDate
+
+      @fromDate = fromDate
+      @toDate = toDate
+      @carrierId = carrierId
+      @statusId = statusId
+      @startOrderId = startOrderId
+      @endOrderId = endOrderId
+      @carrierTrackingNumber = carrierTrackingNumber
+      @referenceValue = referenceValue
+      super()
+    end
+
+    def order_properties
+      {
+        fromDate: fromDate,
+        toDate: toDate,
+        carrierId: carrierId,
+        statusId: statusId,
+        startOrderId: startOrderId,
+        endOrderId: endOrderId,
+        carrierTrackingNumber: carrierTrackingNumber,
+        referenceValue: referenceValue,
+      }.compact
+    end
+
+    def request_body
+      builder = build do |xml|
+        xml.OrderSearchRequest do
+          xml.Order(order_properties)
+        end
+      end
+
+      builder.to_xml
+    end
+  end
+end

data/lib/eshipper/requests/request.rb

@@ -0,0 +1,37 @@
+module EShipper
+  class Request
+    def client
+      EShipper::Client.instance
+    end
+
+    def build(&block)
+      Nokogiri::XML::Builder.new do |xml|
+        xml.EShipper(
+          version: "3.1.0",
+          xmlns: "http://www.eshipper.net/XMLSchema",
+          username: client.username,
+          password: client.password
+        ) do
+          yield(xml)
+        end
+      end
+    end
+
+    def send_now
+      uri = URI(EShipper::Client.instance.url)
+      http_request = Net::HTTP::Post.new(uri.path)
+      http_request.body = request_body
+
+      http_session = Net::HTTP.new(uri.host, uri.port)
+      http_session.use_ssl = true
+      http_session.read_timeout = 3000
+      http_session.set_debug_output($stdout)
+
+      http_response = http_session.start do |http|
+        http.request(http_request)
+      end
+
+      http_response.body
+    end
+  end
+end

data/lib/eshipper/responses/eshipper_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class EShipperXMLFormatter
+  include ActiveResource::Formats::XmlFormat
+
+  def decode(xml)
+    ActiveResource::Formats::XmlFormat.decode(xml)
+  end
+end
+
+module EShipper
+  class EShipperResponse < ::ActiveResource::Base
+    self.site = EShipper::Client.instance.url
+    self.format = :xml
+  end
+end

data/lib/eshipper/responses/order_information_reply.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module EShipper
+  class OrderInformationReply < EShipperResponse
+    self.format = :xml
+
+    def self.fetch(options)
+      request = EShipper::OrderInformationRequest.new(options)
+      new(format.decode(request.send_now))
+    end
+  end
+end

data/lib/eshipper/responses/search_reply.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module EShipper
+  class SearchReply < EShipperResponse
+    self.format = :xml
+
+    def self.search(options)
+      request = EShipper::OrderSearchRequest.new(options)
+      new(format.decode(request.send_now))
+    end
+  end
+end

data/lib/eshipper/version.rb

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

data/lib/eshipper.rb

@@ -0,0 +1,13 @@
+require "net/http"
+require "nokogiri"
+require "singleton"
+require "yaml"
+require "activeresource"
+
+require("#{File.dirname(__FILE__)}/eshipper/requests/request")
+require("#{File.dirname(__FILE__)}/eshipper/client")
+require("#{File.dirname(__FILE__)}/eshipper/responses/eshipper_response")
+
+Dir.glob("#{File.dirname(__FILE__)}/eshipper/requests/*").sort.each { |file| require(file) }
+Dir.glob("#{File.dirname(__FILE__)}/eshipper/responses/*").sort.each { |file| require(file) }
+Dir.glob("#{File.dirname(__FILE__)}/eshipper/classes/*").sort.each { |file| require(file) }

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: eshipper
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- "Marc \U0001F41D"
+- Daniel Gonzalez
+- Chris Wise
+- Damien Imberdis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  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: nokogiri
+  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'
+description: eShipper API client
+email:
+- hello@inventory.horse
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- eshipper.gemspec
+- lib/eshipper.rb
+- lib/eshipper/classes/order.rb
+- lib/eshipper/client.rb
+- lib/eshipper/requests/order_information_request.rb
+- lib/eshipper/requests/order_search_request.rb
+- lib/eshipper/requests/request.rb
+- lib/eshipper/responses/eshipper_response.rb
+- lib/eshipper/responses/order_information_reply.rb
+- lib/eshipper/responses/search_reply.rb
+- lib/eshipper/version.rb
+homepage: https://github.com/hrdwdmrbl/eshipper
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: eShipper API wrapper for Ruby using ActiveResource
+test_files: []