xpost 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1528ac526307947878501064a5b31c5c128883cf
+  data.tar.gz: a3a71ecaa5c1e6d786ae24e84cef98793b0ffb2a
+SHA512:
+  metadata.gz: 380cd7435dd8e02ef74e2a3de907b6260d3a8c3731903fe9524c6b1909f5f40a0f04225ee55e11769460c224d4c1b1722a5bb5c94ac0b04f42cf849d18326e76
+  data.tar.gz: 49323931c9acd75d1f258dfa6f6f54f46b512991316b0c7c2fc88754e916ba5875c1fcec8b99efe6cedae5e6aade8dd1793e7156f850491ab58ac822d8cc4e37

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+.bundle
+*.lock
+pkg/*
+.ruby-version
+gemfiles/vendor/*
+tmp/
+spec/reports/
+
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 xpanse-ph
+
+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,64 @@
+
+
+# xpost
+
+A ruby gem for accessing the xpost API created by xpanse.
+
+# Configuration
+
+```ruby
+# config/initializers/xpost.rb
+
+Xpost.configure do |config|
+  config.api_key    = 'your_api_key'
+  config.secret_key = 'your_secret_key'
+end
+```
+
+# Authentication
+
+```ruby
+api_key = "1234"
+secret_key = "ABCD"
+
+Xpost::Authentication.authenticate(api_key, secret_key)
+
+# "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0IiwiaWF0IjoxNTI2MzgzMzE0LCJqdGkiOjE1MjYzODMzMTR9.iXbnbn7XRmrq2msAMEGyv8cTl2PWkpfP7EbztKNo00A"
+```
+
+# Order
+
+
+### Order.find
+
+Returns all order data.
+
+```ruby
+auth_token = "..."
+tracking_number = "0076-1174-PSAT"
+
+Xpost::Order.find(auth_token, tracking_number)
+```
+
+### Order.track
+
+Returns the order events of a specific order.
+
+```ruby
+auth_token = "..."
+tracking_number = "0076-1174-PSAT"
+
+Xpost::Order.find(auth_token, tracking_number)
+```
+
+### Order Flow
+
+```ruby
+Order.create(auth_token, options: order_options)
+Order.confirm(auth_token, options/payment_reference_id)
+Order.for_pickup(auth_token, pickup_address)
+```
+
+# Testing
+
+Disclaimer: Most of the API calls still try to connect to an external HTTP connection.

data/lib/xpost.rb

@@ -0,0 +1,23 @@
+module Xpost
+  autoload :Configuration,    'xpost/configuration'
+  autoload :Authentication,   'xpost/authentication'
+  autoload :Orders,           'xpost/orders'
+
+  module Models
+    autoload :Address,  'xpost/models/address'
+    autoload :Item,     'xpost/models/item'
+    autoload :Order,    'xpost/models/order'
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/xpost/authentication.rb

@@ -0,0 +1,33 @@
+require 'base64'
+require 'openssl'
+require 'json'
+
+module Xpost
+  module Authentication
+    def self.authenticate(api_key, secret_key)
+      payload   = payload(api_key)
+      signature = signature(header, payload, secret_key)
+      token     = "#{header}.#{payload}.#{signature}"
+    end
+
+    private
+
+    def self.header
+      url_safe({ "alg" => "HS256", "typ" => "JWT"}.to_json)
+    end
+
+    def self.payload(api_key)
+      iat = jti = Time.now.to_i
+      url_safe({"sub": api_key, "iat": iat, "jti": jti }.to_json)
+    end
+
+    def self.signature(header, payload, secret_key, alg = 'HS256')
+      data = "#{header}.#{payload}"
+      url_safe(OpenSSL::HMAC.digest('SHA256', secret_key, data))
+    end
+
+    def self.url_safe(data)
+      Base64.urlsafe_encode64(data).delete('=')
+    end
+  end
+end

data/lib/xpost/configuration.rb

@@ -0,0 +1,12 @@
+module Xpost
+  class Configuration
+    attr_accessor :api_key, :secret_key, :staging_url, :production_url
+
+    def initialize
+      @api_key
+      @secret_key
+      @staging_url
+      @production_url
+    end
+  end
+end

data/lib/xpost/models.rb

@@ -0,0 +1,5 @@
+module Xpost
+  module Models
+    
+  end
+end

data/lib/xpost/models/address.rb

@@ -0,0 +1,38 @@
+require 'active_model'
+require 'set'
+
+module Xpost
+  module Models
+    class Address
+      include ActiveModel::Model
+
+      REQUIRED_ADDRESS_PARAMETERS = Set[:name, :shipment, :line_1, :city, :state, :postal_code, :country]
+      OPTIONAL_ADDRESS_PARAMETERS = Set[:company, :title, :email, :phone_number, :mobile_number, :fax_number,
+                                        :district, :line_2, :remarks]
+
+      attr_accessor :name, :shipment, :line_1, :city, :state, :postal_code, :country
+      attr_accessor :company, :title, :email, :phone_number, :mobile_number, :fax_number, :district, :line_2, :remarks
+
+      validates_presence_of :name, :shipment, :line_1, :city, :state, :postal_code, :country
+
+      def initialize(options = {})
+        @shipment       = options[:shipment]
+        @name           = options[:name]
+        @email          = options[:email]
+        @phone_number   = options[:phone_number]
+        @mobile_number  = options[:mobile_number]
+        @fax_number     = options[:fax_number]
+        @company        = options[:company]
+        @title          = options[:title]
+        @line_1         = options[:line_1]
+        @line_2         = options[:line_2]
+        @city           = options[:city]
+        @district       = options[:district]
+        @state          = options[:state]
+        @postal_code    = options[:postal_code]
+        @country        = options[:country]
+        @remarks        = options[:remarks]
+      end
+    end
+  end
+end

data/lib/xpost/models/item.rb

@@ -0,0 +1,31 @@
+require 'active_model'
+require 'set'
+
+module Xpost
+  module Models
+    class Item
+      include ActiveModel::Model
+
+      ITEM_TYPES = Set[:product, :shipping, :tax, :fee, :insurance, :discount]
+
+      attr_accessor :type, :description, :amount, :quantity, :metadata
+
+      validates_presence_of :type, :description, :amount
+      validate :check_item_type
+
+      def initialize(options = {})
+        @type         = options[:type]
+        @description  = options[:description]
+        @amount       = options[:amount]
+        @quantity     = options[:quantity]
+        @metadata     = options[:metadata]
+      end
+
+      def check_item_type
+        if self.type.present? && !ITEM_TYPES.include?(self.type.to_sym)
+          errors.add(:type, "wrong item type")
+        end
+      end
+    end
+  end
+end

data/lib/xpost/models/order.rb

@@ -0,0 +1,54 @@
+require 'active_model'
+require 'set'
+
+module Xpost
+  module Models
+    class Order
+      include ActiveModel::Model
+
+      CONFIRMABLE_PARAMETERS  = Set[:status, :email, :buyer_name, :contact_number, :delivery_address, :items,
+                                    :shipment, :total, :currency, :payment_method, :payment_provider]
+      FOR_PICKUP_PARAMETERS   = Set[:pickup_address, :pickup_at]
+
+      attr_accessor :email, :buyer_name, :contact_number
+      attr_accessor :total, :currency, :payment_method, :payment_provider
+      attr_accessor :delivery_address, :pickup_address
+      attr_accessor :status, :items, :shipment
+
+      validates_presence_of :email, :buyer_name, :contact_number
+      validates_presence_of :delivery_address
+
+      def initialize(options = {})
+        @status           = options[:status]
+        @email            = options[:email]
+        @buyer_name       = options[:buyer_name]
+        @contact_number   = options[:contact_number]
+        @delivery_address = options[:delivery_address]
+        @items            = options[:items]
+        @shipment         = options[:shipment]
+        @total            = options[:total]
+        @currency         = options[:currency]
+        @payment_method   = options[:payment_method]
+        @payment_provider = options[:payment_provider]
+        @pickup_address   = options[:pickup_address]
+        @pickup_at        = options[:pickup_at]
+      end
+
+      def confirmable?
+        self.valid? && self.delivery_address.present?
+      end
+
+      # https://docs.quadx.xyz/#5f38afd0-66bb-468f-ab4e-993d4745a257
+      # Sets the order status to canceled. An order can be canceled provided they have not passed the cutoff date and time as specified in the contract.
+      def cancellable?
+        true
+      end
+
+      # https://docs.quadx.xyz/#c831dc25-2de4-36c5-c321-8e9db0fc2105
+      # The following fields can be updated provided they have not passed the cutoff date and time as specified in the contract.
+      def updatable?
+        true
+      end
+    end
+  end
+end

data/lib/xpost/orders.rb

@@ -0,0 +1,96 @@
+require 'json'
+require 'set'
+require 'typhoeus'
+
+# Ideal Order.create flow
+#   order = Order.create({...})
+#   order.confirm / order.cancel
+#   order.for_pickup(pickup_address, pickup_date)
+#   order.update({...})
+
+module Xpost
+  class Orders
+    # cant actually get all orders since its paginated
+    def self.all(auth_token)
+      all_orders_url = "orders"
+
+      get_url(all_orders_url, headers: auth_header(auth_token))
+    end
+
+    def self.find(auth_token, tracking_number)
+      find_order_url  = "orders/#{tracking_number}"
+
+      res = get_url(find_order_url, headers: auth_header(auth_token))
+      res = res[:message] == "Not Found" ? "Not Found" : res
+    end
+
+    def self.track(auth_token, tracking_number)
+      track_order_url = "orders/#{tracking_number}"
+
+      res = get_url(track_order_url, headers: auth_header(auth_token))
+      res = res[:message] == "Not Found" ? "Not Found" : { timeline: res[:tat], events: res[:events] }
+    end
+
+    def self.create(auth_token, options = {})
+      raise "Missing order data" if options[:order_data].empty?
+
+      create_order_url      = "orders"
+      order_data            = options[:order_data]
+      
+      res = post_url(create_order_url, data: order_data, headers: auth_header(auth_token))
+    end
+
+    def self.confirm(auth_token, tracking_number, payment_reference_id)
+      confirm_order_url = "orders/#{tracking_number}/confirm"
+
+      res = put_url(confirm_order_url, data: payment_reference_id, headers: auth_header(auth_token))
+      res = res[:message] == "Not Found" ? "Not Found" : res
+    end
+
+    def self.for_pickup(auth_token, tracking_number, pickup_address)
+      pickup_address = Xpost::Models::Address.new(pickup_address)
+      for_pickup_url = "orders/#{tracking_number}/for-pickup"
+
+      raise "Invalid address" unless pickup_address.valid?
+
+      res = put_url(for_pickup_url, data: pickup_address, headers: auth_header(auth_token))
+      res = res[:message] == "Not Found" ? "Not Found" : res
+    end
+
+    private
+
+    def self.base_url
+      Xpost.configuration.production_url
+    end
+
+    def self.auth_header(auth_token)
+      {"Authorization" => "Bearer #{auth_token}"}
+    end
+
+    def self.get_url(url, options = {})
+      req_url = "#{base_url}/#{url}"
+      req_options = {headers: options[:headers]}
+
+      res = Typhoeus::Request.get(req_url, req_options).body
+      res = JSON.parse(res, symbolize_names: true)
+    end
+
+    def self.post_url(url, options = {})
+      headers     = { 'Content-Type': 'application/json' }.merge options[:headers]
+      req_url     = "#{base_url}/#{url}"
+      req_options = { headers: headers, body: options[:data].to_json }
+
+      res = Typhoeus::Request.post(req_url, req_options).body
+      res = JSON.parse(res, symbolize_names: true)
+    end
+
+    def self.put_url(url, options = {})
+      headers     = { 'Content-Type': 'application/json' }.merge options[:headers]
+      req_url     = "#{base_url}/#{url}"
+      req_options = { headers: headers, body: options[:data].to_json }
+
+      res = Typhoeus::Request.put(req_url, req_options).body
+      res = JSON.parse(res, symbolize_names: true)
+    end
+  end
+end

data/lib/xpost/version.rb

@@ -0,0 +1,3 @@
+module Xpost
+  VERSION = "0.1.1"
+end

data/spec/address_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+RSpec.describe 'Address' do
+  it 'works' do
+    address = build(:address)
+
+    expect(address.name).to eq 'Bobby Axelrod'
+    expect(address.line_1).to eq 'Axe Capital'
+  end
+
+  describe 'with required parameters' do
+    it 'is valid' do
+      address = build(:required_address)
+      expect(address).to be_valid
+    end
+
+    it 'is invalid with missing parameters' do
+      address = build(:required_address, name: nil)
+      expect(address).not_to be_valid
+      expect(address.errors.messages).to eq(name: ["can't be blank"])
+    end
+  end
+
+  describe 'with complete parameters' do
+    it 'is valid' do
+      address = build(:complete_address)
+      expect(address.valid?).to be true
+    end
+
+    it 'is invalid without the required parameters' do
+      address = build(:complete_address, name: nil)
+      expect(address.valid?).to be false
+      expect(address.errors.messages).to eq(name: ["can't be blank"])
+    end
+
+    it 'is valid without the optional parameters' do
+      address = build(:complete_address, company: nil)
+      expect(address.valid?).to be true
+    end
+  end
+end

data/spec/factories/addresses.rb

@@ -0,0 +1,39 @@
+FactoryBot.define do
+  factory :address, class: Xpost::Models::Address do
+    name "Bobby Axelrod"
+    line_1 "Axe Capital"
+  end
+
+  factory :required_address, class: Xpost::Models::Address do
+    name "Bobby Axelrod"
+    shipment "small-pouch"
+    line_1 "855 Sixth Avenue"
+    city "New York"
+    state "NY"
+    postal_code 10001
+    country "US"
+
+    initialize_with { new(attributes) }
+  end  
+
+  factory :complete_address, class: Xpost::Models::Address do
+    name "Bobby Axelrod"
+    shipment "small-pouch"
+    line_1 "855 Sixth Avenue"
+    city "New York"
+    state "NY"
+    postal_code 10001
+    country "US"
+    company "Axe Capital"
+    title "CEO"
+    email "bobby@axe.com"
+    phone_number "12345678"
+    mobile_number "091712345678"
+    fax_number "12345678"
+    district "Manhattan"
+    line_2 "5th floor"
+    remarks "Send ASAP"
+    
+    initialize_with { new(attributes) }
+  end
+end

data/spec/factories/items.rb

@@ -0,0 +1,17 @@
+FactoryBot.define do
+  factory :product_item, class: Xpost::Models::Item do
+    type "product"
+    description "orange shirt"
+    amount 1200
+    initialize_with { new(attributes) }
+  end
+
+  factory :complete_product_item, class: Xpost::Models::Item do
+    type "product"
+    description "red shirt"
+    amount 1000
+    quantity 1
+    metadata "Small"
+    initialize_with { new(attributes) }
+  end
+end

data/spec/factories/orders.rb

@@ -0,0 +1,36 @@
+FactoryBot.define do
+  factory :order, class: Xpost::Models::Order do
+    email "john@me.com"
+    buyer_name "John Doe"
+    contact_number "+6391712345678"
+
+    total 1500
+    currency "PHP"
+    payment_method "cod"
+    payment_provider "lbcx"
+
+    items { [build(:complete_product_item)] }
+    delivery_address { build(:complete_address) }
+  end
+
+  factory :cod_order, class: Xpost::Models::Order do
+    email "john@me.com"
+    buyer_name "John Doe"
+    contact_number "+6391712345678"
+
+    total 1500
+    currency "PHP"
+    payment_method "cod"
+    payment_provider "lbcx"
+
+    items { [build(:complete_product_item)] }
+    delivery_address { build(:complete_address) }
+  end
+
+  # factory :confirmable_order, class: Xpost::Models::Order do
+  # end
+  
+  # factory :for_pickup_order, class: Xpost::Models::Order do
+  # end
+
+end

data/spec/helpers.rb

@@ -0,0 +1,12 @@
+module Helpers
+  def auth_token
+    Xpost.configure do |config|
+      config.api_key        = 'api_key'
+      config.secret_key     = 'secret_key'
+      config.staging_url    = "https://api.staging.lbcx.ph/v1"
+      config.production_url = "https://api.staging.lbcx.ph/v1"
+    end
+    
+    auth_token = Xpost::Authentication.authenticate(Xpost.configuration.api_key, Xpost.configuration.secret_key)
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+RSpec.describe 'Item' do
+  it 'works' do
+    item = build(:product_item)
+
+    expect(item).to be_valid
+    expect(item.type).to eq "product"
+    expect(item.description).to eq "orange shirt"
+    expect(item.amount).to eq 1200
+  end
+
+  it 'requires a valid item_type' do
+    expect(build(:product_item, type: "product")).to be_valid
+    expect(build(:product_item, type: "productz")).not_to be_valid
+  end
+
+  describe 'with required parameters' do
+    it 'is valid' do
+      item = build(:product_item)
+      expect(item).to be_valid
+    end
+
+    it 'is invalid with missing parameters' do
+      item = build(:product_item, amount: nil)
+      expect(item.valid?).to eq false
+    end
+  end
+
+  describe 'with complete parameters' do
+    it 'is valid' do
+      item = build(:complete_product_item)
+      expect(item).to be_valid
+    end
+
+    it 'is invalid without the required parameters' do
+      item = build(:complete_product_item, type: nil)
+      expect(item).not_to be_valid
+    end
+
+    it 'is valid without the optional parameters' do
+      item = build(:complete_product_item, quantity: nil)
+      expect(item).to be_valid
+    end
+  end
+end
+

data/spec/line_item_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+RSpec.describe 'LineItem' do
+
+  describe 'with require parameters' do
+    # it 'is valid' do
+    #   line_item = build(:line_item)
+    #   expect(line_item).to be_valid
+    # end
+
+    # it 'is invalid with missing parameters' do
+    #   line_item = build(:line_item, type: nil)
+    #   expect(line_item).not_to be_valid
+    # end
+  end
+end

data/spec/orders/order_create_spec.rb

@@ -0,0 +1,46 @@
+require 'set'
+require 'spec_helper'
+
+RSpec.describe "Orders.create" do
+  before(:each) do
+    @order = build(:order)
+  end
+
+  it 'requires a delivery address' do
+    order_without_delivery_address = build(:order, delivery_address: nil)
+    order_with_delivery_address = build(:order)
+    expect(order_without_delivery_address).not_to be_valid
+    expect(order_with_delivery_address).to be_valid
+  end
+
+  it 'requires a payment method' do
+    expect(@order.payment_method).to be_present
+    expect(@order.payment_provider).to be_present
+  end
+
+  it 'requires at least one product in line items' do
+    expect(@order.items.count).to eq 1
+    expect(@order.items.first.description).to eq "red shirt"
+  end
+
+  # TODO: Skipping calls for now to prevent multiple
+  #       orders from being added to the staging site.
+
+  
+  # it 'creates an order' do
+  #   auth_token = Xpost::Authentication.local_auth
+  #   @res = Xpost::Orders.create(auth_token, @order)
+  #   expect(@res[:tracking_number]).to eq 200
+  # end
+
+  # describe 'returning a valid order object' do
+  #   before(:each) do
+  #     auth_token = Xpost::Authentication.local_auth
+  #     @res = Xpost::Orders.create(auth_token, @order)
+  #   end
+
+  #   it 'has a tracking number'
+  #   it 'has a status of confirming'
+  # end
+
+end

data/spec/orders/order_for_pickup_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+RSpec.describe "@order.for_pickup" do
+  before do
+    Xpost.configure do |config|
+      config.api_key        = 'api_key'
+      config.secret_key     = 'secret_key'
+      config.staging_url    = "https://api.staging.lbcx.ph/v1"
+      config.production_url = "https://api.staging.lbcx.ph/v1"
+    end
+    @auth_token = Xpost::Authentication.authenticate(Xpost.configuration.api_key, Xpost.configuration.secret_key)
+  end
+
+  it 'already has a delivery address'
+  it 'requires a pickup address'
+
+end

data/spec/orders/orders_find_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe "Orders.find" do
+  before do
+    Xpost.configure do |config|
+      config.api_key        = 'api_key'
+      config.secret_key     = 'secret_key'
+      config.staging_url    = "https://api.staging.lbcx.ph/v1"
+      config.production_url = "https://api.staging.lbcx.ph/v1"
+    end
+    @auth_token = Xpost::Authentication.authenticate(Xpost.configuration.api_key, Xpost.configuration.secret_key)
+  end
+  
+  it 'returns a valid order' do
+    tracking_number = "0076-1174-PSAT"
+    order = Xpost::Orders.find(@auth_token, tracking_number)
+    
+    expect(order[:id]).to eq 761174
+  end
+
+  it 'fails on an invalid order' do
+    tracking_number = "0076-1174-PSAZ"
+    order = Xpost::Orders.find(@auth_token, tracking_number)
+
+    expect(order).to eq "Not Found"
+  end
+end

data/spec/orders/orders_track_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+RSpec.describe "Orders.track" do
+  before do
+    Xpost.configure do |config|
+      config.api_key        = 'api_key'
+      config.secret_key     = 'secret_key'
+      config.staging_url    = "https://api.staging.lbcx.ph/v1"
+      config.production_url = "https://api.staging.lbcx.ph/v1"
+    end
+    @auth_token = Xpost::Authentication.authenticate(Xpost.configuration.api_key, Xpost.configuration.secret_key)
+  end
+  
+  it 'returns a valid order' do
+    tracking_number = "0076-1174-PSAT"
+    order_events = Xpost::Orders.track(@auth_token, tracking_number)
+
+    expect(order_events[:timeline].count).to eq 5
+  end
+
+  it 'fails on an invalid order' do
+    tracking_number = "0076-1174-PSAZ"
+    order_events = Xpost::Orders.track(@auth_token, tracking_number)
+
+    expect(order_events).to eq "Not Found"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+require 'factory_bot'
+require 'xpost'
+
+require 'helpers'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include Helpers
+
+  # factory_bot
+  config.include FactoryBot::Syntax::Methods
+  config.before(:suite) do
+    FactoryBot.find_definitions
+  end
+end

data/spec/xpost_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe Xpost do
+  before do
+    @auth_token = auth_token
+  end
+
+  describe 'Configuration' do
+    it 'has keys' do
+      expect(Xpost.configuration.api_key).to eq 'api_key'
+      expect(Xpost.configuration.secret_key).to eq 'secret_key'
+    end
+
+    it 'has a staging url' do
+      expect(Xpost.configuration.staging_url).to eq "https://api.staging.lbcx.ph/v1"
+    end
+
+    it 'has a production url' do
+      expect(Xpost.configuration.production_url).to eq "https://api.staging.lbcx.ph/v1"
+    end
+  end
+
+  # TODO: need a better way to verify validity of the auth_token
+  describe 'Authentication' do
+    describe '.authenticate' do
+      it 'returns an auth_token' do
+        api_key     = Xpost.configuration.api_key
+        secret_key  = Xpost.configuration.secret_key
+        auth_token  = Xpost::Authentication.authenticate(api_key, secret_key)
+
+        expect(auth_token).to_not be nil
+        expect(@auth_token).to_not be nil
+      end
+    end
+  end
+end
+

data/xpost.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xpost/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'xpost'
+  s.version     = Xpost::VERSION
+  s.authors     = ["David Marquez"]
+  s.email       = 'david@xpanse.ph'
+
+  s.summary     = "xpost Ruby API"
+  s.date        = '2018-04-27'
+  s.description = "A quick wrapped of the xpost API written by xpanse."
+  s.homepage    = 'http://rubygems.org/gems/xpost'
+  s.license     = 'MIT'
+  
+  s.files       = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'activemodel', '~> 5.2'
+  s.add_dependency 'typhoeus', '~> 1.3'
+  s.add_dependency 'factory_bot', '~> 4.8'
+  # s.add_dependency 'vcr', '~> 4.0'
+
+  s.add_development_dependency 'bundler', "~> 1.16"
+  s.add_development_dependency 'rake', "~> 12.3"
+  s.add_development_dependency 'rspec', '~> 3.2'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: xpost
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- David Marquez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !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'
+description: A quick wrapped of the xpost API written by xpanse.
+email: david@xpanse.ph
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- lib/xpost.rb
+- lib/xpost/authentication.rb
+- lib/xpost/configuration.rb
+- lib/xpost/models.rb
+- lib/xpost/models/address.rb
+- lib/xpost/models/item.rb
+- lib/xpost/models/order.rb
+- lib/xpost/orders.rb
+- lib/xpost/version.rb
+- spec/address_spec.rb
+- spec/factories/addresses.rb
+- spec/factories/items.rb
+- spec/factories/orders.rb
+- spec/helpers.rb
+- spec/item_spec.rb
+- spec/line_item_spec.rb
+- spec/orders/order_create_spec.rb
+- spec/orders/order_for_pickup_spec.rb
+- spec/orders/orders_find_spec.rb
+- spec/orders/orders_track_spec.rb
+- spec/spec_helper.rb
+- spec/xpost_spec.rb
+- xpost.gemspec
+homepage: http://rubygems.org/gems/xpost
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: xpost Ruby API
+test_files: []