ingram_micro 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f3a454c5b9cd87a1f71320f583ecd4f04345fed
+  data.tar.gz: de4da596e98cd56963ac0575b697cf57d98ba488
+SHA512:
+  metadata.gz: d8bf2f4381068729b8311af77ebbc29ff0b29a55d37af7e5de7c404a0122c2db43fbad4f6a0e3e78a09cdc4448b10de9d8b7dbcd657897b76d6336d60852d41c
+  data.tar.gz: 35d0cf4b16c9f0ee80c9c40812ad9a099417bda5d79ddde5f53cd477ba1c2a1f8b34d76a245702a0e8e2ad7cbc84820abdcd4ff62e11088f061d70ec747d3d3b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+.idea
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+lib/config/defaults.yml

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ingram_micro.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rachel Heaton
+
+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,123 @@
+# IngramMicro
+[![Build Status](https://travis-ci.org/WalkerAndCoBrandsInc/ingram_micro.svg?branch=develop)](https://travis-ci.org/WalkerAndCoBrandsInc/ingram_micro) Development
+
+[![Build Status](https://travis-ci.org/WalkerAndCoBrandsInc/ingram_micro.svg?branch=master)](https://travis-ci.org/WalkerAndCoBrandsInc/ingram_micro) Latest Release
+
+
+[IngramMicro](http://www.ingrammicro.com/IMD_WASWeb/jsp/login/corporate.jsp) HTTPS XML API wrapper.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ingram_micro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ingram_micro
+
+
+Modify the spec_helper.rb and provide a api_root. You can create one on requestb.in
+
+## Run the Tests
+
+    $ rake
+
+## Usage
+
+The `example.rb` script demonstrates how to use this gem. When 
+configured, it creates a sales order with Ingram Micro.
+
+To see configuration options see `lib/ingram_micro/configuration.rb` 
+
+```
+  IngramMicro.configure do |config|
+    config.api_root = "https://ingramurl.com"
+    config.partner_name = 'account name'
+    config.partner_password = 'password'
+    config.debug = true
+    config.logger = Rails.logger
+  end
+```
+
+The `IngramMicro::Client` class creates the connection to the Brightpoint API
+using the Faraday gem. The `Transmission` super class has subclasses (i.e. `SalesOrder`)
+that correspond to different uses of the API.
+
+These subclasses create XML files, tackling one element at a time. Hence the
+`BaseElement` class and its subclasses for each element found in the forms. These
+elements are designed to create XML elements that are empty or containing a
+default value (hence the `DEFAULTS` hash constant) if no values are provided,
+which is why the RSpec tests can create a new SalesOrder without providing any
+information.
+
+XML files are validated against the XSD schemas from the API docs and then
+sent the request to the API.
+
+More detailed instructions for use will be provided once we have tested and
+calibrated this gem to work properly with the API.
+
+## For sites hosted in the cloud :cloud:
+
+You may not be able to get a range of IPs for Ingram Micro to whitelist. 
+To get around this, you can route requests through [tinyproxy](https://github.com/tinyproxy/tinyproxy). 
+
+Make sure to allow the ports that IngramMicro gives you to connect to e.g.
+
+  tinyproxy.conf
+
+```
+  [...]
+  ConnectPort 9443
+  [...]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Development with tinyproxy
+
+e.g. on a mac with homebrew (homebrew puts tinyproxy in sbin)
+
+    $ brew install tinyproxy
+
+- create a tinyproxy.conf [Example](https://github.com/tinyproxy/tinyproxy/blob/186bbc3efb4b47caac0b5e14465c97918c99e442/etc/tinyproxy.conf.in)
+- set your LogFile (config file does not understand ~ and needs full path)
+- set ConnectPort for ports IMM uses
+
+### Configuring Ingram Micro for a proxy
+
+```
+  IngramMicro.configure do |config|
+    [...]
+    config.proxy = 'http://localhost:8888'
+  end
+```
+
+### Testing the proxy with curl
+
+```
+$ tinyproxy -d -c path/to/tinyproxy.conf
+$ tail -f path/to/file.log
+$ curl -x localhost:8888 https://blog.engineyard.com -v
+```
+
+You should see logging that the proxy is working!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WalkerAndCoBrandsInc/ingram_micro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ingram_micro"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example.rb

@@ -0,0 +1,18 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'ingram_micro'
+require 'logger'
+
+IngramMicro.configure do |config|
+  config.api_root = ''
+  config.partner_name = 'Your company'
+  config.partner_password = ''
+  config.customer_id = '12345'
+  config.debug = true
+  config.logger = Logger.new(STDOUT)
+end
+
+options = {}
+transmission = IngramMicro::SalesOrder.new(options)
+transmission.send_request

data/ingram_micro.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ingram_micro/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ingram_micro"
+  spec.version       = IngramMicro::VERSION
+  spec.authors       = ["Rachel Heaton","Joseph Nguyen", "Ben Christel"]
+  spec.email         = ["rachelmheaton@gmail.com"]
+
+  spec.summary       = %q{Rubygem wrapper for Ingram Micro API}
+  spec.homepage      = "https://github.com/WalkerAndCoBrandsInc/ingram_micro"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+  spec.add_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "factory_girl", "~>4.0"
+end

data/lib/ingram_micro.rb

@@ -0,0 +1,42 @@
+require "nokogiri"
+require "faraday"
+require "faraday_middleware"
+require "ingram_micro/version"
+require "ingram_micro/configuration"
+require "ingram_micro/client"
+require "ingram_micro/base_element"
+require "ingram_micro/transmission"
+require "ingram_micro/transmissions/sales_order"
+require "ingram_micro/transmissions/check_shipment_status"
+require "ingram_micro/transmissions/return_authorization"
+require "ingram_micro/elements/customer"
+require "ingram_micro/request_processor"
+require "ingram_micro/elements/shipment_information"
+require "ingram_micro/elements/credit_card_information"
+require "ingram_micro/elements/sales_order_header"
+require "ingram_micro/elements/return_order_header"
+require "ingram_micro/elements/detail"
+require "ingram_micro/elements/sales_order_line_item"
+require "ingram_micro/elements/shipment_status_line_item"
+require "ingram_micro/elements/return_authorization_line_item"
+require "ingram_micro/elements/message_header_pw"
+require "ingram_micro/elements/message_header_no_pw"
+require "ingram_micro/elements/sales_order_submission"
+require "ingram_micro/elements/return_authorization_submission"
+require "ingram_micro/elements/purchase_order_information"
+require "ingram_micro/elements/shipment_status"
+require "ingram_micro/errors/invalid_type"
+require "ingram_micro/errors/missing_field"
+
+module IngramMicro
+  GEM_DIR = (File.dirname(__FILE__) + '/../').freeze
+
+  def self.configuration
+    @configuration ||= IngramMicro::Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+    configuration.assert_valid
+  end
+end

data/lib/ingram_micro/base_element.rb

@@ -0,0 +1,32 @@
+class IngramMicro::BaseElement
+
+  attr_accessor :element
+
+  def initialize(options={})
+    @element = {}
+    self.defaults.each do |field, default|
+      value = (options[field] ? options[field] : default)
+      @element[field] = value
+    end
+    @element[:customer_id] ||= IngramMicro.configuration.customer_id
+  end
+
+  def build(builder)
+    self.defaults.keys.each do |field|
+      element_name = field.to_s.gsub('_', '-')
+      element_value = @element[field]
+      builder.send(element_name, element_value)
+    end
+  end
+
+  def parse(message_hash)
+    defaults.each do |field|
+      element_name = field.to_s.gsub('_', '-')
+      @element[field] = message_hash[element_name]
+    end
+  end
+
+  def integer?(string)
+    Integer(string) != nil rescue false
+  end
+end

data/lib/ingram_micro/client.rb

@@ -0,0 +1,49 @@
+require 'uri'
+class IngramMicro::Client
+
+  attr_reader :uri, :conn
+
+  def initialize(url=api_root)
+    @uri = URI.parse(url)
+    @conn = Faraday.new(url: uri) do |faraday|
+      faraday.request  :url_encoded
+      faraday.response :logger, logger, bodies: log_request_body
+      faraday.adapter  Faraday.default_adapter
+      faraday.proxy proxy if proxy
+    end
+  end
+
+  def get
+    conn.get uri.request_uri
+  end
+
+  def post(data)
+    conn.post do |req|
+      req.url uri.request_uri
+      req.headers['Content-Type'] = 'application/xml'
+      req.body = data
+    end
+  end
+
+  private
+
+  def api_root
+    configuration.api_root
+  end
+
+  def logger
+    configuration.logger
+  end
+
+  def log_request_body
+    configuration.log_request_body
+  end
+
+  def proxy
+    configuration.proxy
+  end
+
+  def configuration
+    IngramMicro.configuration
+  end
+end

data/lib/ingram_micro/configuration.rb

@@ -0,0 +1,46 @@
+require 'yaml'
+
+module IngramMicro
+  class Configuration
+    attr_accessor :api_root, :debug, :logger,
+      :partner_name, :partner_password,
+      :log_request_body, :customer_id, :proxy
+
+    def assert_valid
+      assert_present :partner_name
+      assert_present :api_root
+      assert_present :customer_id
+      fail Error.new('logger must be set if debug is set') unless logger_valid?
+      fail Error.new('customer_id must be an integer') unless customer_id_valid?
+      fail Error.new('proxy must have protocol http://') unless proxy_valid?
+    end
+
+    private
+
+    def assert_present(field_name)
+      fail Error.new("#{field_name} is required") unless present?(field_name)
+    end
+
+    def logger_valid?
+      return true unless debug
+
+      present?(:logger)
+    end
+
+    def customer_id_valid?
+      customer_id.to_s =~ /^\d+$/
+    end
+
+    def proxy_valid?
+      return true if proxy.nil?
+
+      proxy =~ /^http:\/\//
+    end
+
+    def present?(field_name)
+      !send(field_name).nil?
+    end
+
+    class Error < StandardError; end
+  end
+end