powa_api 0.0.3

data/.gitignore

@@ -0,0 +1,25 @@
+.rvmrc
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.yml
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Rubymine files
+.idea/
+
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in powa-api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,37 @@
+powa-api
+========
+
+Ruby interface to the POWA API
+
+[http://developer.powa.com/guide](http://developer.powa.com/guide)
+
+Configuration
+-------------
+
+### Yaml example
+
+```yaml
+environment: "sandbox"
+integration_security_key: "KEY-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
+website_authorisation_token: "TOKEN-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
+```
+
+Then
+
+```ruby
+PowaApi.configure_with("path/to/yaml/file")
+```
+
+### Ruby example
+
+```ruby
+PowaApi.configure(:environment => "sandbox", :integration_security_key => "KEY-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+ :website_authorisation_token => "TOKEN-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")
+```
+
+Usage
+-------------
+
+```ruby
+products = PowaApi::ProductService.get_products
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/powa_api/order_service.rb

@@ -0,0 +1,76 @@
+module PowaApi
+  class OrderService < PowaService
+
+    def self.find_updated_orders(updated_from, updated_to = nil)
+
+      client = Savon.client wsdl
+
+      response = client.request :get_updated_orders do
+        soap.xml do |xml|
+          xml.soapenv(:Envelope, namespaces) do |xml|
+
+            header_block(xml)
+
+            xml.soapenv(:Body) do |xml|
+              xml.urn(:FindUpdatedOrdersRequest) do |xml|
+                xml.updatedFrom updated_from.strftime('%FT%T.000')
+                xml.updateTo updated_to.strftime('%FT%T.000') if updated_to
+              end
+            end
+          end
+        end
+      end
+
+      [response.to_array(:find_updated_orders_response).first[:orders]].flatten.compact
+
+    end
+
+    def self.get_order_details(order_number)
+
+      client = Savon.client wsdl
+
+      begin
+        response = client.request :get_order_details do
+          soap.xml do |xml|
+            xml.soapenv(:Envelope, namespaces) do |xml|
+
+              header_block(xml)
+
+              xml.soapenv(:Body) do |xml|
+                xml.urn(:GetOrderDetailsRequest) do |xml|
+                  xml.orderNumber order_number
+                end
+              end
+            end
+          end
+        end
+      rescue Savon::SOAP::Fault => e
+        return nil if e.message.include?("Order not found")
+        raise e.message
+      end
+
+      response.to_array(:get_order_details_response).first
+
+    end
+
+    # This method invokes find_updated_orders and then calls get_order_details for each order
+    # and returns an array of the results
+    def self.get_orders(start_date, end_date)
+      orders = []
+      order_ids = OrderService.find_updated_orders(start_date, end_date)
+
+      order_ids.each do |order_id|
+        orders << OrderService.get_order_details(order_id)
+      end
+
+      return orders.flatten.compact
+    end
+
+    private
+
+    def self.wsdl
+      base_url + "OrderService?wsdl"
+    end
+
+  end
+end

data/lib/powa_api/powa_service.rb

@@ -0,0 +1,54 @@
+module PowaApi
+  class PowaService
+
+    def self.get_publish_info
+      client = Savon.client wsdl
+
+      response = client.request :get_publish_info do
+        soap.xml do |xml|
+          xml.soapenv(:Envelope, namespaces) do |xml|
+
+            header_block(xml)
+
+            xml.soapenv(:Body) do |xml|
+              xml.urn(:GetPublishInfoRequest) do |xml|
+             end
+            end
+          end
+        end
+      end
+
+      response.to_array(:get_publish_info_response).first
+    end
+
+    protected
+
+    def self.wsdl
+      base_url + "PublishService?wsdl"
+    end
+
+    def self.base_url
+      if ::PowaApi.config[:environment] == "production"
+        "https://api.powa.com/ws/soap/v2/"
+      else
+        "https://api.sandbox.powa.com/ws/soap/v2/"
+      end
+    end
+
+    def self.header_block(xml)
+      xml.soapenv(:Header) do |xml|
+        xml.urn(:Credentials) do |xml|
+          xml.integrationSecurityKey ::PowaApi.config[:integration_security_key]
+          xml.websiteAuthorisationToken ::PowaApi.config[:website_authorisation_token]
+        end
+      end
+    end
+
+    def self.namespaces
+      {
+        "xmlns:soapenv" => "http://schemas.xmlsoap.org/soap/envelope/",
+        "xmlns:urn" => "urn:powa:api:PowaAPI"
+      }
+    end
+  end
+end

data/lib/powa_api/product_service.rb

@@ -0,0 +1,106 @@
+module PowaApi
+  class ProductService < PowaService
+
+    def self.get_published_products(publish_token, batch_number = nil)
+      client = Savon.client wsdl
+
+      response = client.request :get_published_products do
+        soap.xml do |xml|
+          xml.soapenv(:Envelope, namespaces) do |xml|
+
+            header_block(xml)
+
+            xml.soapenv(:Body) do |xml|
+              xml.urn(:GetPublishedProductsRequest) do |xml|
+                xml.publishToken publish_token
+                xml.batchNumber batch_number if batch_number
+             end
+            end
+          end
+        end
+      end
+
+      [response.to_array(:get_published_products_response).first[:products]].flatten.compact
+    end
+
+    def self.get_published_products_by_sku(*skus)
+      client = Savon.client wsdl
+
+      response = client.request :get_published_products_by_sku do
+        soap.xml do |xml|
+          xml.soapenv(:Envelope, namespaces) do |xml|
+
+            header_block(xml)
+
+            xml.soapenv(:Body) do |xml|
+              xml.urn(:GetProductsBySkuRequest) do |xml|
+                xml.skuList do |xml|
+                  skus.each do |sku|
+                    xml.sku sku
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+
+      [response.to_array(:get_products_by_sku_response).first[:product]].flatten.compact
+    end
+
+    def self.get_products(batch_number = nil)
+
+      client = Savon.client wsdl
+
+      response = client.request :get_products do
+        soap.xml do |xml|
+          xml.soapenv(:Envelope, namespaces) do |xml|
+
+            header_block(xml)
+
+            xml.soapenv(:Body) do |xml|
+              xml.urn(:GetProductsRequest) do |xml|
+                xml.batchNumber batch_number if batch_number
+             end
+            end
+          end
+        end
+      end
+
+      [response.to_array(:get_products_response).first[:product]].flatten.compact
+
+    end
+
+    def self.get_products_by_sku(*skus)
+      client = Savon.client wsdl
+
+      response = client.request :get_products_by_sku do
+        soap.xml do |xml|
+          xml.soapenv(:Envelope, namespaces) do |xml|
+
+            header_block(xml)
+
+            xml.soapenv(:Body) do |xml|
+              xml.urn(:GetProductsBySkuRequest) do |xml|
+                xml.skuList do |xml|
+                  skus.each do |sku|
+                    xml.sku sku
+                  end
+                end
+             end
+            end
+          end
+        end
+      end
+
+      [response.to_array(:get_products_by_sku_response).first[:product]].flatten.compact
+    end
+
+    private
+
+    def self.wsdl
+      base_url + "ProductService?wsdl"
+    end
+
+  end
+end

data/lib/powa_api/version.rb

@@ -0,0 +1,3 @@
+module PowaApi
+  VERSION = "0.0.3"
+end

data/lib/powa_api.rb

@@ -0,0 +1,40 @@
+require 'savon'
+require 'yaml'
+require 'powa_api/version'
+require 'powa_api/powa_service'
+require 'powa_api/product_service'
+require 'powa_api/order_service'
+
+module PowaApi
+
+  extend self
+
+  @config = {
+              :integration_security_key => "KEY-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+              :website_authorisation_token => "TOKEN-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
+              :environment => "sandbox"
+            }
+
+  @valid_config_keys = @config.keys
+
+  def self.configure(opts = {})
+    opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  def self.configure_with(path_to_yaml_file)
+    begin
+      config = YAML::load(IO.read(path_to_yaml_file))
+    rescue Errno::ENOENT
+      log(:warning, "YAML configuration file couldn't be found. Using defaults."); return
+    rescue Psych::SyntaxError
+      log(:warning, "YAML configuration file contains invalid syntax. Using defaults."); return
+    end
+
+    configure(config)
+  end
+
+  def self.config
+    @config
+  end
+
+end

data/powa_api.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'powa_api/version'
+
+Gem::Specification.new do |s|
+  s.name        = "powa_api"
+  s.version     = PowaApi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["jzw", "mikelarkin"]
+  s.email       = []
+  s.homepage    = "http://github.com/mikelarkin/powa_api"
+  s.summary     = "Implementation of the Powa API"
+  s.description = "Implementation of the Powa API"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "powa_api"
+
+  s.add_development_dependency "bundler", ">= 1.0.0.rc.5"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").select{|f| f =~ /^bin/}
+  s.require_path = 'lib'
+  s.add_dependency 'savon'
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: powa_api
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- jzw
+- mikelarkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70218966339480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc.5
+  type: :development
+  prerelease: false
+  version_requirements: *70218966339480
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: &70218966338120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70218966338120
+description: Implementation of the Powa API
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/powa_api.rb
+- lib/powa_api/order_service.rb
+- lib/powa_api/powa_service.rb
+- lib/powa_api/product_service.rb
+- lib/powa_api/version.rb
+- powa_api.gemspec
+homepage: http://github.com/mikelarkin/powa_api
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: powa_api
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Implementation of the Powa API
+test_files: []