channeladvisor 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.yardoc/*
+doc/*
+coverage/*

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+script: "bundle exec rake spec"

data/.yardopts

@@ -0,0 +1,8 @@
+--no-private
+--protected
+--markup markdown
+--markup-provider redcarpet
+lib/**/*.rb
+-
+README.md
+LICENSE

data/Gemfile

@@ -0,0 +1,31 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in channeladvisor.gemspec
+gemspec
+
+group :test do
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+  gem 'guard-yard', "~> 2.0.0", :platforms => [:ruby] if RUBY_VERSION >= "1.9.2"
+  gem 'rb-inotify',   :require => false if RUBY_PLATFORM =~ /linux/i
+  gem 'libnotify',    :require => false if RUBY_PLATFORM =~ /linux/i
+  gem 'rb-fsevent',   :require => false if RUBY_PLATFORM =~ /darwin/i
+  gem 'growl',        :require => false if RUBY_PLATFORM =~ /darwin/i
+  gem 'win32console', :require => false, :platforms => [:mswin, :mingw]
+  gem 'rb-fchange',   :require => false, :platforms => [:mswin, :mingw]
+  gem 'rb-notifu',    :require => false, :platforms => [:mswin, :mingw]
+
+  platform :ruby_19 do
+    gem 'simplecov'
+  end
+end
+
+group :development do
+  gem 'yard'
+  gem 'redcarpet'
+end
+
+# platform :ruby_19 do
+#   gem 'ruby-debug19'
+#   gem 'pry'
+# end

data/Guardfile

@@ -0,0 +1,28 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+	watch('Gemfile')
+	watch(%r{^.+\.gemspec$})
+end
+
+if RUBY_PLATFORM =~ /w32/i
+	guard 'rspec', :run_all => {:cli => '-f p'}, :all_after_pass => false do
+	  watch(%r{^(spec/.+_spec\.rb)$})	{ |m| "#{m[1]}" }
+	  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+	  watch('spec/spec_helper.rb')  { "spec" }
+	end
+else
+	guard 'yard', :stdout => '/dev/null', :stderr => '/dev/null' do
+	  watch(%r{lib/.+\.rb})
+	  watch('README.md')
+	  watch('LICENSE')
+	  watch('.yardopts')
+	end
+
+	guard 'rspec', :rvm => ['1.9.2@channeladvisor', '1.9.3@channeladvisor'], :run_all => {:cli => '-f p'}, :all_after_pass => false do
+	  watch(%r{^(spec/.+_spec\.rb)$})	{ |m| "#{m[1]}" }
+	  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+	  watch('spec/spec_helper.rb')  { "spec" }
+	end
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 David Nunez 
+
+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,40 @@
+ChannelAdvisor [![Build Status](https://secure.travis-ci.org/dnunez24/channeladvisor.png)](http://travis-ci.org/dnunez24/channeladvisor)
+==============
+
+Ruby wrapper for the SOAP API provided by ChannelAdvisor.
+
+Install
+-------
+
+Install the gem:
+
+```bash
+$ gem install channeladvisor
+```
+
+Usage
+-----
+
+Setup the ChannelAdvisor client:
+
+```ruby
+require 'channeladvisor'
+
+ChannelAdvisor.configure do |config|
+  config.developer_key = YOUR_DEVELOPER_KEY
+  config.password      = YOUR_PASSWORD
+  config.account_id    = YOUR_ACCOUNT_ID
+end
+```
+
+Make a request to the service:
+
+```ruby
+date_range = DateTime.new(2012,05,01)..DateTime.new(2012,06,01)
+
+orders = ChannelAdvisor::Order.list(:created_between => date_range)
+# => [<ChannelAdvisor::Order>, <ChannelAdvisor::Order>, ...]
+
+orders.first.id
+# => 1234567
+```

data/Rakefile

@@ -0,0 +1,69 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "channeladvisor/version"
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["--format progress"]
+end
+
+task :default => :spec
+ 
+task :build do
+  system "gem build channeladvisor.gemspec"
+end
+ 
+task :release => :build do
+  system "gem push channeladvisor-#{ChannelAdvisor::VERSION}"
+end
+
+desc "Display current gem version"
+task :version do
+  puts "Current version: #{ChannelAdvisor::VERSION}"
+end
+
+namespace :version do
+  desc "Bump version (defaults to patch)"
+  task :bump => "bump:patch"
+
+  namespace :bump do
+    desc "Bump major version"
+    task :major => :version do |t|
+      bump_version(t.name.split(":").last)
+    end
+
+    desc "Bump minor version"
+    task :minor => :version do |t|
+      bump_version(t.name.split(":").last)
+    end
+
+    desc "Bump patch version"
+    task :patch => :version do |t|
+      bump_version(t.name.split(":").last)
+    end
+  end
+end
+
+def bump_version(segment)
+  segments = ChannelAdvisor::VERSION.split(".").map(&:to_i)
+
+  case segment
+  when "major"
+    segments[0] = segments[0] + 1 
+    segments[1] = 0
+    segments[2] = 0
+  when "minor"
+    segments[1] = segments[1] + 1 
+    segments[2] = 0
+  when "patch"
+    segments[2] = segments[2] + 1 
+  end
+
+  new_version = segments.join(".")
+
+  file_name = "lib/channeladvisor/version.rb"
+  new_text = File.read(file_name).gsub(ChannelAdvisor::VERSION, new_version)
+  File.open(file_name, "w") { |f| f.puts new_text }
+
+  puts "New version: #{new_version}" 
+end

data/channeladvisor.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "channeladvisor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "channeladvisor"
+  s.version     = ChannelAdvisor::VERSION
+  s.authors     = ["Dave Nunez"]
+  s.email       = ["dnunez24@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby wrapper for the ChannelAdvisor API}
+  s.description = %q{Provides an easy-to-use interface for making requests to the ChannelAdvisor API. Includes all methods for requesting and updating data via API version 6.}
+
+  s.rubyforge_project = "channeladvisor"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "rr", "~> 1.0.0"
+  s.add_development_dependency "vcr", "~> 2.2.0"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+  s.add_development_dependency "timecop"
+
+  s.add_runtime_dependency "savon", "~> 1.0.0"
+end

data/lib/channeladvisor.rb

@@ -0,0 +1,27 @@
+require 'savon'
+require 'channeladvisor/version'
+require 'channeladvisor/error'
+require 'channeladvisor/configuration'
+require 'channeladvisor/client'
+require 'channeladvisor/services'
+require 'channeladvisor/base'
+require 'channeladvisor/admin'
+require 'channeladvisor/order'
+require 'channeladvisor/order_status'
+require 'channeladvisor/payment'
+require 'channeladvisor/shipment'
+require 'channeladvisor/address'
+require 'channeladvisor/shopping_cart'
+require 'channeladvisor/line_item'
+require 'channeladvisor/account_authorization'
+
+module ChannelAdvisor
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+end
+

data/lib/channeladvisor/account_authorization.rb

@@ -0,0 +1,14 @@
+module ChannelAdvisor
+  class AccountAuthorization
+    attr_reader :account_id, :local_id, :account_name, :account_type, :resource_name, :status
+
+    def initialize(account_id, local_id, account_name, account_type, resource_name, status)
+      @account_id     = account_id
+      @local_id       = local_id
+      @account_name   = account_name
+      @account_type   = account_type
+      @resource_name  = resource_name
+      @status         = status
+    end
+  end
+end

data/lib/channeladvisor/address.rb

@@ -0,0 +1,39 @@
+module ChannelAdvisor
+  class Address
+    attr_accessor :line1, :line2, :city, :region, :region_description, :postal_code, :country_code,
+      :company_name, :job_title , :title, :first_name, :last_name, :suffix, :daytime_phone, :evening_phone
+
+    def initialize(attrs={})
+      @line1              = attrs[:address_line1]
+      @line2              = attrs[:address_line2]
+      @city               = attrs[:city]
+      @region             = attrs[:region]
+      @region_description = attrs[:region_description]
+      @postal_code        = attrs[:postal_code]
+      @country_code       = attrs[:country_code]
+      @company_name       = attrs[:company_name]
+      @job_title          = attrs[:job_title]
+      @title              = attrs[:title]
+      @first_name         = attrs[:first_name]
+      @last_name          = attrs[:last_name]
+      @suffix             = attrs[:suffix]
+      @daytime_phone      = attrs[:phone_number_day]
+      @evening_phone      = attrs[:phone_number_evening]
+    end
+
+    def full_name
+      [@title, @first_name, @last_name].join(" ") + ", #{@suffix}"
+    end
+
+    def formatted
+      <<-EOF
+        #{full_name}
+        #{job_title}
+        #{@line1}
+        #{@line2}
+        #{@city}, #{@region} #{@postal_code}
+        #{@country_code}
+      EOF
+    end
+  end
+end

data/lib/channeladvisor/admin.rb

@@ -0,0 +1,75 @@
+module ChannelAdvisor
+  class Admin < Base
+    class << self
+      attr_reader :last_response
+
+      # Check authorization for and availability of the admin service
+      #
+      # @raise [ServiceFailure] If the SOAP response status is `Failure`
+      # @raise [SOAPFault] If the service responds with a SOAP fault
+      # @raise [HTTPError] If the service responds with an HTTP error
+      #
+      # @return [Boolean] Returns `true` if the SOAP response status is `Success`
+      def ping
+        handle_errors do
+          @last_response = Services::AdminService.ping
+          result = @last_response[:ping_response][:ping_result]
+          check_status_of result
+        end
+      end
+
+      # Request access to a specific ChannelAdvisor account
+      #
+      # @param [Integer] local_id Local ID of the ChannelAdvisor account to which you are requesting access
+      #
+      # @raise [ServiceFailure] If the SOAP response status is `Failure`
+      # @raise [SOAPFault] If the service responds with a SOAP fault
+      # @raise [HTTPError] If the service responds with an HTTP error
+      #
+      # @return [Boolean] Returns `true` if the SOAP response status is `Success`
+      def request_access(local_id)
+        handle_errors do
+          @last_response = Services::AdminService.request_access(local_id)
+          result = @last_response[:request_access_response][:request_access_result]
+          check_status_of result
+        end
+      end
+
+      # Retrieve a list of account authorizations for the given developer key and optional local ID
+      #
+      # @param [Integer] local_id Local ID of the ChannelAdvisor account for which you are checking authorization status
+      #
+      # @raise [ServiceFailure] If the SOAP response status is `Failure`
+      # @raise [SOAPFault] If the service responds with a SOAP fault
+      # @raise [HTTPError] If the service responds with an HTTP error
+      #
+      # @return [Array<AccountAuthorization>] An array of account authorizations
+      def get_authorization_list(local_id=nil)
+        handle_errors do
+          @last_response = Services::AdminService.get_authorization_list(local_id)
+          result = @last_response[:get_authorization_list_response][:get_authorization_list_result]
+          check_status_of result
+
+          account_authorizations = []
+          
+          if result_data = result[:result_data]
+            authorizations = arrayify result_data[:authorization_response]
+
+            authorizations.each do |authorization|
+              account_authorizations << AccountAuthorization.new(
+                authorization[:account_id],
+                authorization[:local_id],
+                authorization[:account_name],
+                authorization[:account_type],
+                authorization[:resource_name],
+                authorization[:status]
+              )
+            end
+          end
+
+          return account_authorizations
+        end
+      end
+    end # self
+  end # Admin
+end # ChannelAdvisor

data/lib/channeladvisor/base.rb

@@ -0,0 +1,34 @@
+module ChannelAdvisor
+  class Base
+
+  private
+
+    def arrayify(data)
+      self.class.arrayify(data)
+    end
+
+    def check_status_of(result)
+      self.class.check_status_of result
+    end
+
+    def handle_errors
+      self.class.handle_errors { yield }
+    end
+
+    def self.arrayify(data)
+      data.is_a?(Array) ? data : [data]
+    end
+
+    def self.check_status_of(result)
+      result[:status] == "Success" || raise(ServiceFailure, result[:message])
+    end
+
+    def self.handle_errors
+      yield
+    rescue Savon::SOAP::Fault => fault
+      raise SOAPFault.new(fault)
+    rescue Savon::HTTP::Error => error
+      raise HTTPError.new(error)
+    end
+  end # Base
+end # ChannelAdvisor