xpost 0.1.2 → 0.1.3

data/spec/orders/{orders_find_spec.rb → find_spec.rb}

@@ -3,8 +3,8 @@ 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.api_key        = ENV['XPOST_STAGING_API_KEY']
+      config.secret_key     = ENV['XPOST_STAGING_SECRET_KEY']
       config.staging_url    = "https://api.staging.lbcx.ph/v1"
       config.production_url = "https://api.staging.lbcx.ph/v1"
     end
@@ -16,6 +16,7 @@ RSpec.describe "Orders.find" do
     order = Xpost::Orders.find(@auth_token, tracking_number)
     
     expect(order[:id]).to eq 761174
+    expect(order[:tracking_number]).to eq "0076-1174-PSAT"
   end
 
   it 'fails on an invalid order' do

data/spec/orders/{orders_track_spec.rb → track_spec.rb}

@@ -3,8 +3,8 @@ 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.api_key        = ENV['XPOST_STAGING_API_KEY']
+      config.secret_key     = ENV['XPOST_STAGING_SECRET_KEY']
       config.staging_url    = "https://api.staging.lbcx.ph/v1"
       config.production_url = "https://api.staging.lbcx.ph/v1"
     end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'bundler/setup'
 require 'factory_bot'
+require 'dotenv/load'
 require 'xpost'
 
 require 'helpers'

data/spec/xpost_spec.rb

@@ -33,5 +33,32 @@ RSpec.describe Xpost do
       end
     end
   end
+
+  describe 'Statuses' do
+    before do
+      Xpost.configure do |config|
+        config.api_key        = ENV['XPOST_STAGING_API_KEY']
+        config.secret_key     = ENV['XPOST_STAGING_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 statuses' do
+      statuses = Xpost::Statuses.all(@auth_token)
+
+      expect(statuses.count).to_not eq 0
+      expect(statuses.first[:name]).to eq "pending"
+      expect(statuses.first[:label]).to eq "Pending"
+    end
+
+    it 'fails to retrieve statuses with an invalid auth_token' do
+      statuses = Xpost::Statuses.all("random_invalid_auth_token")
+
+      expect(statuses[:status]).to eq 401
+      expect(statuses[:message]).to eq "Unauthorized"
+    end
+  end
 end
 

data/xpost.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.email       = 'david@xpanse.ph'
 
   s.summary     = "xpost Ruby API"
-  s.date        = '2018-04-27'
+  s.date        = '2018-08-09'
   s.description = "A quick wrapped of the xpost API written by xpanse."
   s.homepage    = 'http://rubygems.org/gems/xpost'
   s.license     = 'MIT'
@@ -17,12 +17,15 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
   
-  s.add_dependency 'activemodel', '~> 5.2'
+  s.add_dependency 'activemodel', '~> 5.1'
   s.add_dependency 'typhoeus', '~> 1.3'
   s.add_dependency 'factory_bot', '~> 4.8'
+  s.add_dependency 'fast_jsonapi', '~> 1.3'
   # s.add_dependency 'vcr', '~> 4.0'
 
   s.add_development_dependency 'bundler', "~> 1.16"
+  s.add_development_dependency 'faker', "~> 1.9"
   s.add_development_dependency 'rake', "~> 12.3"
   s.add_development_dependency 'rspec', '~> 3.2'
+  s.add_development_dependency 'dotenv', '~> 2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xpost
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - David Marquez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-27 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: A quick wrapped of the xpost API written by xpanse.
 email: david@xpanse.ph
 executables: []
@@ -107,26 +149,36 @@ files:
 - LICENSE
 - README.md
 - TODO.md
+- lib/.DS_Store
 - lib/xpost.rb
+- lib/xpost/.DS_Store
+- lib/xpost/address.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/item.rb
+- lib/xpost/order.rb
 - lib/xpost/orders.rb
+- lib/xpost/statuses.rb
 - lib/xpost/version.rb
-- spec/address_spec.rb
+- sample/sample_essential_order_details.json
+- sample/sample_xpost_order-confirmed.json
+- sample/sample_xpost_order-for-pickup.json
+- sample/sample_xpost_order-pending.json
+- sample/webhook_sample.json
 - 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/order/address/address_spec.rb
+- spec/order/cancel_spec.rb
+- spec/order/confirm_spec.rb
+- spec/order/create_spec.rb
+- spec/order/for_pickup_spec.rb
+- spec/order/get_shipping_label_spec.rb
+- spec/order/items/item_spec.rb
+- spec/order/order_spec.rb
+- spec/orders/find_spec.rb
+- spec/orders/track_spec.rb
 - spec/spec_helper.rb
 - spec/xpost_spec.rb
 - xpost.gemspec

data/lib/xpost/models.rb

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

data/lib/xpost/models/address.rb

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

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

@@ -1,54 +0,0 @@
-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/spec/line_item_spec.rb

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

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

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