Project

rlm_logistics

0.0
No commit activity in last 3 years
No release in over 3 years
rlm_logisticsjgrubbs/rlm_logisticsHomepageDocumentationSource CodeBug TrackerWiki
Ruby API wrapper for RLM logistics
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
10,043
Stars
0
Forks
0
Watchers
2
 Releases
Current version
0.1.3
Total releases
4
First release
2016-03-23
Latest release
2016-04-29
 Development
Primary Language
Ruby
Average date of last 50 commits
2016-03-04
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.10
byebug
>= 0
codeclimate-test-reporter
>= 0
rake
~> 10.0
rspec
>= 0
vcr
~> 2.9.3
webmock
~> 1.21.0

Runtime

active_record-remote
~> 0.0.3
 Project Readme

RLM Logistics

Build Status

This is a Ruby library for interfacing with the RLM API.

Installation

Add this line to your application's Gemfile:

gem 'rlm_logistics'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rlm_logistics

Usage

config/inializer/rlm.rb

RlmLogistics.config do |r|
  r.username      = "XXUSER"
  r.password      = "XXKEY"
  r.endpoint_path = "TESTServices"
  r.company       = 90
end

inventory

RLM documentation

inventories = RlmLogistics::Record::Inventory.where(
  retrieve_upcs:    'Y',
  division_number:  10,
  ats_includes_wip: 'N'
)
# =>
# [
#    <RlmLogistics::Record::Inventory...>,
#    <RlmLogistics::Record::Inventory...>,
#    <RlmLogistics::Record::Inventory...>
# ]

sales order

RLM documentation

shipping_address = {
  name:         "My Name",
  address1:     "ad1",
  address2:     "ad2",
  city:         "My city",
  state:        "NY",
  zip:          "My zip",
  country_code: "USA",
  address_type: "S"
}

billing_address = {
  name:         "My Name",
  address1:     "ad10",
  city:         "My city",
  state:        "NY",
  zip:          "My zip",
  address_type: "B"
}

line_items = [
  {
    sku_number: 4,
    style:      "CB11D10",
    color:      "BLUE",
    size:       "S",
    price:      10.99,
    quantity:   1
  }
]

sales_order = RlmLogistics::Record::SalesOrder.new(
  division_number: 50,
  email:           "customer@gmail.com",
  currency:        "$",
  order_date:      20120115,
  start_date:      20120115,
  cancel_date:     20120115,
  customer_po:     "YOURPO#",
  special01:       101,
  special02:       102,
  special03:       103,
  special04:       104,
  discount:        0.05,
  warehouse:       1,
  addresses: [
    shipping_address,
    billing_address
  ],
  details: line_items
)

sales_order.save

If order submitted(saved) successfully the sales_order will have an id that relates to RLM's order id.

credits

RLM documentation

credit = RlmLogistics::Record::Credit.new(
  date_from: 20130131,
  date_to:   20130601
)

credit.save
credit.parsed_data
# =>
# [
#    <RlmLogistics::Record::Credit...>,
#    <RlmLogistics::Record::Credit...>,
#    <RlmLogistics::Record::Credit...>
# ]

items

RLM documentation

items = RlmLogistics::Record::Item.where(
  division_number: 10,
  retrieve_upcs:   "Y"
)
# =>
# [
#    <RlmLogistics::Record::Item...>,
#    <RlmLogistics::Record::Item...>,
#    <RlmLogistics::Record::Item...>
# ]

packed orders

RLM documentation

packed_order = RlmLogistics::Record::PackedOrder.all
# =>
# [
#    <RlmLogistics::Record::PackedOrder...>,
#    <RlmLogistics::Record::PackedOrder...>,
#    <RlmLogistics::Record::PackedOrder...>
# ]

error handling

Validation and errors are handled by ActiveModel so error handling looks like this:

sales_order.errors.full_messages
# => ["The user/key combination does not exist"]
sales_order.valid?
# => false

Contributing

  1. Fork it ( https://github.com/[my-github-username]/rlm_logistics/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request