pixi_client 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77cfd8b058cb754f613001a1baa7c8e1c817d66f
+  data.tar.gz: bc7b81ec4fae4646a02d0819a0409a244e7dc9d6
+SHA512:
+  metadata.gz: f61855a79f76b7a03cc4530c50f6f599ff4c3ab5df3f957ebc680ee0551499dc40f65a6f416ba932808cb9f6c7504ff67abe22d9a9cefae8109679c0e23129e2
+  data.tar.gz: 574bb4b37a33be78f8b2b1341785517a363eaf221e530b70a2c747696a88a31e37ce931b603224ba20960fb1dac6c32fc246fd0c1af4504eed12652fbc85c51a

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Pixi data connection
+/config/pixi.yml
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color --format doc --backtrace
+--require spec_helper

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,45 @@
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec feature)
+
+## Uncomment to clear the screen before every task
+clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), the you will want to move the Guardfile
+## to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec --color --format documentation --format Nc" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 heragu
+
+MIT License
+
+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,171 @@
+# PixiClient
+
+PixiClient is a ruby client for the pixi SOAP API.
+
+The intent behind it was to abstract all the SOAP and nasty Microsoft SqlRowSet1 details involved in the SOAP communication, letting the programmer to work with plain ruby objects, instead of XML response messages or hash objects.
+
+It also offers an easy way to include new requests to the API.
+
+## Background
+
+Do I need to read this section to use the gem? No, at all. You can jump to Installation if you feel like it.
+
+It's boring technical stuff about the implementation, but it could be useful if one day you run into troubles. ;-)
+
+The pixi SOAP API always responses with messages that follow the Microsoft SqlRowSet1 XML schema. The messages that follow this schema contains esentially three parts:
+* A collection of warning and/or error messages
+* A collection of field descriptors, that indicates how the rows of the response are structured
+* A collection of rows containing the data
+
+The pixi_client gem uses the file descriptors to build ruby objects at runtime using OpenStruct.
+The messages are also parsed and returned as Ruby objects using OpenStruct.
+
+See also the [reference about the Microsoft SqlRowSet1 schema documentation](https://msdn.microsoft.com/en-us/library/ee320384(v=sql.105).aspx).
+
+## Requirements
+
+The gem has been tested with Ruby versions >= 2.1.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pixi_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pixi_client
+
+## Usage
+
+### Configuration
+
+#### Rails
+
+config/initializers/pixi_client.rb
+
+```ruby
+PixiClient.configure do |config|
+  config.endpoint = <your_pixi_endpoing_url>
+  config.username = <your_pixi_username>
+  config.password = <your_pixi_password>
+end
+```
+
+### Example of usage
+
+To have a list of the implemented requests, have a look to the lib/requests folder.
+
+All the requests have a common interface: the request to pixi is performed when the `call` method is invoked and it returns a response object.
+
+The returned response object has two main methods:
+* rows: an array of OpenStruct instances, where every instance has the attributes described in the API documentation with the data type described in the XML schema. If the response is empty, it returns an empty array.
+* messages: an array of OpenStruct instances, where every instance represent a warning or error message.
+
+For example, suppose you want to get the changed stock in the last 15 minutes using the API service `pixiGetChangedItemsStock` (`PixiClient::Requests::GetChangedItemStock`).
+
+According to the pixi documentation the response is a collection of rows with the following columns:
+* ItemKey
+* ItemNrInt
+* EANUPC
+* ItemNrSuppl
+* PhysicalStock
+* AvailableStock
+* StockChange
+* EstimatedDelivery
+* MinStockQty
+* Enabled
+* OpenSupplierOrderQTY
+* UpdateDate
+* OriginalUpdateDate
+* BundleItem
+* RowNr
+
+```ruby
+response = PixiClient::Requests::GetChangedItemStock.new(since: 15.minutes.ago).call
+
+single_row = response.rows.first
+
+# Single row is an OpenStruct with the following ruby attributes:
+# => item_key
+# => item_nr_int
+# => eanup
+# => item_nr_suppl
+# => physical_stock
+# => available_stock
+# => stock_change
+# => estimated_delivery
+# => min_stock_qty
+# => enabled
+# => open_supplier_order_qty
+# => update_date
+# => original_update_date
+# => bundle_item
+# => row_nr
+
+```
+### Extending it
+
+We don't implement all the possible requests to the pixi SOAP API. Disappointed? You shouldn't.
+
+We don't implement all, but we offer an easy way to add new requests without dealing with SOAP and Microsoft SqlRowSet1 dirty details.
+
+To add a new request, you just need to extend `PixiClient::Requests::Base` and provide the following three methods:
+* `initialize`: not mandatory, but useful to set the parameters your call needs.
+* `api_method`: it must return a symbol with the name of the SOAP request following the lowercase separated by underscores naming convention. For example, if you want to call the service pixiGetStockBins the method should return `:pixi_get_stock_bins`.
+* `message`: it must return a hash with the request parameters.
+
+As example, let's implement `pixiGetStockBins` request. This request returns a list of all Bins available in the stock. It has three parameters, all optional:
+* `LocID`: to filter bins by location ID.
+* `RowCount`: Max rowcount to return. By default 0: return all.
+* `Start`: Index of the row to start with. The default value is 0.
+
+```ruby
+class GetStockBins < PixiClient::Requests::Base
+  attr_accessor :loc_id, :row_count, :start
+
+  def initialize(params = {})
+    self.loc_id = params[:loc_id]
+    self.row_count = params[:row_count] || 0
+    self.start = params[:start] || 0
+  end
+
+  def api_method
+    :pixi_get_stock_bins
+  end
+
+  def message
+    message = {}
+    message['LocID'] = loc_id if loc_id.present?
+    message.merge({
+      'RowCount' => row_count,
+      'Start' => start
+    })
+  end
+end # That's it!
+
+# Let's have fun printting out all our bins :-)
+response = GetStockBins.new.call
+response.rows.each do |bin|
+  puts "#{bin.bin_name}"
+end
+```
+
+A couple of tips when you are adding new requests:
+* Before you implement a new call, it is recommended that you install [Wizdler Chrome Extension](https://chrome.google.com/webstore/detail/wizdler/oebpmncolmhiapingjaagmapififiakb). This extesion will let you to play in your browser easily with the pixi API. It is also really helpful when the pixi documentation is incomplete or has errors, what happens often.
+* Consider that the order of the parameters is relevant. If the documentation lists the parameters in the order `LocID`, `RowCount` and `Start`, they should be provided in this order in the message hash (or omitted if they are optional). If you don't do this way, the API will complaint and return an error.
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/pixi_client/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`). Here some tips how to write a good commit message: https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation']
+end
+
+task :default => :spec

data/lib/pixi_client/configuration.rb

@@ -0,0 +1,5 @@
+module PixiClient
+  class Configuration
+    attr_accessor :endpoint, :username, :password
+  end
+end

data/lib/pixi_client/requests/add_comment_to_order.rb

@@ -0,0 +1,20 @@
+module PixiClient
+  module Requests
+    class AddCommentToOrder < Base
+      attr_accessor :order_nr, :comment
+
+      def initialize(order_nr, comment)
+        self.order_nr = order_nr
+        self.comment = comment
+      end
+
+      def api_method
+        :pixi_add_order_comment
+      end
+
+      def message
+        { 'OrderNr' => order_nr, 'Comment' => comment }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/base.rb

@@ -0,0 +1,25 @@
+require 'savon'
+
+module PixiClient
+  module Requests
+    class Base
+      TIME_STRING_FORMAT = '%Y-%m-%dT%H:%M:%S.%3N'
+      FIVE_MINUTES = 5 * 60
+
+      def call
+        response = client.call(api_method, attributes: { xmlns: PixiClient.configuration.endpoint }, message: message)
+        Response.new(api_method, response.body)
+      end
+
+      private
+
+      def client
+        @client ||= Savon.client(
+          wsdl: PixiClient.configuration.endpoint + '?wsdl',
+          ssl_verify_mode: :none,
+          basic_auth: [PixiClient.configuration.username, PixiClient.configuration.password]
+        )
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/cancel_order.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class CancelOrder < Base
+      attr_accessor :order_nr
+
+      def initialize(order_nr)
+        self.order_nr = order_nr
+      end
+
+      def api_method
+        :pixi_cancel_order
+      end
+
+      def message
+        { 'OrderNr' => order_nr }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/cancel_order_line.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class CancelOrderLine < Base
+      attr_accessor :order_line_key
+
+      def initialize(order_line_key)
+        self.order_line_key = order_line_key
+      end
+
+      def api_method
+        :pixi_cancel_orderline
+      end
+
+      def message
+        { 'OrderlineKey' => order_line_key }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_changed_item_stock.rb

@@ -0,0 +1,27 @@
+module PixiClient
+  module Requests
+    class GetChangedItemStock < Base
+
+      attr_accessor :since, :row_count, :offset, :location_id
+
+      def initialize(opts)
+        self.since = opts[:since]
+        self.row_count = opts[:row_count]
+        self.offset = opts[:offset]
+        self.location_id = opts[:location_id]
+      end
+
+      def api_method
+        :pixi_get_changed_item_stock
+      end
+
+      def message
+        { 'Since' => since.strftime(TIME_STRING_FORMAT) }.tap do |opts|
+          opts['RowCount'] = row_count unless row_count.nil?
+          opts['LocID'] = location_id unless location_id.nil?
+          opts['Start'] = offset unless offset.nil?
+        end
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_changed_items.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class GetChangedItems < Base
+      attr_accessor :since
+
+      def initialize(opts)
+        self.since = opts[:since]
+      end
+
+      def api_method
+        :pixi_get_changed_items
+      end
+
+      def message
+        { 'Since' => since.strftime(TIME_STRING_FORMAT) }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_invoice.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class GetInvoice < Base
+      attr_accessor :invoice_number
+
+      def initialize(invoice_number)
+        self.invoice_number = invoice_number
+      end
+
+      def api_method
+        :pixi_get_invoice
+      end
+
+      def message
+        { 'InvoiceNr' => invoice_number }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_item_info.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class GetItemInfo < Base
+      include Itemable
+
+      attr_accessor :item_id_key, :item_id
+
+      def initialize(item_id_key, item_id)
+        self.item_id_key = item_id_key
+        self.item_id = item_id
+      end
+
+      def api_method
+        :pixi_get_item_info
+      end
+
+    end
+  end
+end

data/lib/pixi_client/requests/get_item_stock_bins.rb

@@ -0,0 +1,18 @@
+module PixiClient
+  module Requests
+    class GetItemStockBins < Base
+      include Itemable
+
+      attr_accessor :item_id_key, :item_id
+
+      def initialize(item_id_key, item_id)
+        self.item_id_key = item_id_key
+        self.item_id = item_id
+      end
+
+      def api_method
+        :pixi_get_item_stock_bins
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_items_info.rb

@@ -0,0 +1,34 @@
+module PixiClient
+  module Requests
+    class GetItemsInfo < Base
+      attr_accessor :ean_codes, :location_id
+
+      def initialize(ean_codes, location_id)
+        self.ean_codes = ean_codes
+        self.location_id = location_id
+      end
+
+      def api_method
+        :pixi_get_item_info
+      end
+
+      def message
+        { 'LocID' => location_id, 'ItemXML' => xml_message }
+      end
+
+      def xml_message
+        builder = Builder::XmlMarkup.new
+
+        builder.ITEMS do
+          ean_codes.each do |code|
+            builder.ITEM do
+              builder.EAN code
+            end
+          end
+        end
+
+        builder.target!
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_items_on_stock_bin.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class GetItemsOnStockBin < PixiClient::Requests::Base
+      attr_accessor :bin_name
+
+      def initialize(bin_name)
+        self.bin_name = bin_name
+      end
+
+      def api_method
+        :pixi_get_items_on_stock_bin
+      end
+
+      def message
+        { 'BinName' => bin_name }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_items_stock_history.rb

@@ -0,0 +1,18 @@
+module PixiClient
+  module Requests
+    class GetItemsStockHistory < Base
+      attr_accessor :message
+
+      # Pixi* documentation says that the pixi order number
+      # is mandatory for this requests
+      def initialize(message)
+        self.message = message
+      end
+
+      def api_method
+        :pixi_get_items_stock_history
+      end
+
+    end
+  end
+end

data/lib/pixi_client/requests/get_order_comments.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class GetOrderComments < Base
+      attr_accessor :pixi_order_number
+
+      def initialize(pixi_order_number)
+        self.pixi_order_number = pixi_order_number
+      end
+
+      def api_method
+        :pixi_get_order_comments
+      end
+
+      def message
+        { 'OrderNr' => pixi_order_number }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_order_header.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class GetOrderHeader < Base
+      attr_accessor :order_id
+
+      def initialize(order_id)
+        self.order_id = order_id
+      end
+
+      def api_method
+        :pixi_get_order_header
+      end
+
+      def message
+        { 'OrderNrExternal' => order_id }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_order_line_history.rb

@@ -0,0 +1,22 @@
+module PixiClient
+  module Requests
+    class GetOrderLineHistory < Base
+      attr_accessor :order_line_key
+
+      # Pixi* documentation says that the pixi order number
+      # is mandatory for this requests
+      def initialize(order_line_key)
+        self.order_line_key = order_line_key
+      end
+
+      def api_method
+        :pixi_get_orderline_history
+      end
+
+      def message
+        { 'OrderlineKey' => order_line_key}
+      end
+
+    end
+  end
+end

data/lib/pixi_client/requests/get_order_lines.rb

@@ -0,0 +1,21 @@
+module PixiClient
+  module Requests
+    class GetOrderLines < Base
+      attr_accessor :pixi_order_number
+
+      # Pixi* documentation says that the pixi order number
+      # is mandatory for this requests
+      def initialize(pixi_order_number)
+        self.pixi_order_number = pixi_order_number
+      end
+
+      def api_method
+        :pixi_get_orderline
+      end
+
+      def message
+        { 'OrderNR' => pixi_order_number }
+      end
+    end
+  end
+end

data/lib/pixi_client/requests/get_order_nr_external_by_box_nr.rb

@@ -0,0 +1,19 @@
+module PixiClient
+  module Requests
+    class GetOrderNrExternalByBoxNr < Base
+      attr_accessor :box_nr
+
+      def initialize(opts)
+        self.box_nr = opts[:box_nr]
+      end
+
+      def api_method
+        :pixi_get_order_nr_external_by_box_nr
+      end
+
+      def message
+        { 'BoxNr' => box_nr }
+      end
+    end
+  end
+end