RubyGems - sapoci-connect - Versions diffs - 0.1.7 - Mend

sapoci-connect 0.1.7

Files changed (9) hide show

data/CHANGELOG.md +41 -0
data/LICENSE +21 -0
data/README.md +54 -0
data/bin/sapoci-search +90 -0
data/lib/sapoci/connect/middleware/background_search.rb +22 -0
data/lib/sapoci/connect/middleware/follow_redirects.rb +55 -0
data/lib/sapoci/connect/middleware/pass_cookies.rb +25 -0
data/lib/sapoci/connect.rb +54 -0
metadata +171 -0

data/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,41 @@
+*2011-10-15 (0.1.7)*
+* Accept GET and POST on ./bin/sapoci-search
+*2011-09-22 (0.1.6)*
+* Fixed parsing issues with longtext field on HTML (from SAPOCI gem)
+*2011-09-07 (0.1.5)*
+* Raise RedirectWithoutLocation error when returning
+  HTTP status 302 without setting the HTTP Location header
+*2011-09-06 (0.1.4)*
+* Make POSTs really post as encoded name/value pairs in the body
+*2011-09-06 (0.1.3)*
+* Changed middleware for background search to put
+  `SAPOCI::Document` into `response.env[:sapoci]`
+  instead of `response.env[:body]`.
+*2011-09-06 (0.1.2)*
+* Changed semantics of search to always add HTTP method,
+  i.e. `:get` or `:post`
+* Added test for timeout errors
+* Added test for relative redirects (i.e. redirects without hostname)
+*2011-08-30 (0.1.1)*
+* Simplify API by separating connection initialization (Faraday) and OCI
+  handling via Faraday middleware.
+* Added `bin/sapoci-search` script to perform, you name it, SAP OCI
+  background search.
+*2011-08-29 (0.1.0)*
+* Initial version, supporting OCI background search only.

data/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+Copyright (c) 2007-2011 Oliver Eilhard
+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 ADDED Viewed

@@ -0,0 +1,54 @@
+# SAP OCI Connect
+We use this library to work with eprocurement punchout systems that
+comply to the SAP OCI 4.0 specification.
+## Features
+### SAP OCI Background Search
+It's as simple as this:
+    conn = Faraday.new("http://onlineshop.com/path", :params => {"token" => "123"}) do |builder|
+      builder.use SAPOCI::Connect::Middleware::FollowRedirects
+      builder.use SAPOCI::Connect::Middleware::PassCookies
+      builder.use SAPOCI::Connect::Middleware::BackgroundSearch
+      builder.adapter :net_http
+    end
+    conn.options[:timeout] = 5
+    conn.options[:open_timeout] = 10
+    resp = SAPOCI::Connect.search(:get, conn, "toner", "http://return.to/me")
+    puts resp.status # => 200
+    puts resp.body   # => <SAPOCI::Document>
+    puts resp.env[:raw_body]   # => "<html>...</html>"
+Review [Faraday](https://github.com/technoweenie/faraday) for details on
+connection initiation.
+## Testing
+Here's how to test locally:
+    $ bundle update
+    $ # Start a second console
+    $ ruby test/live_server.rb
+    $ # Back in first console
+    $ rake
+To test external servers, use the REMOTE environment variable:
+    $ REMOTE="http://remote-site.com/Login.aspx?u=demo&p=secret" rake
+## Credits
+Standing on the shoulder of giants, where giants include:
+* Rick Olson for [faraday](https://github.com/technoweenie/faraday),
+* Ilya Grigorik for [em-synchrony](https://github.com/igrigorik/em-synchrony),
+  [em-http-request](https://github.com/igrigorik/em-http-request) and stuff,
+* David Balatero and Paul Dix for [typhoeus](https://github.com/dbalatero/typhoeus)
+... and many other contributors. Thanks, guys. You rock!

data/bin/sapoci-search ADDED Viewed

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'optparse'
+require 'ostruct'
+require 'uri'
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+require 'sapoci/connect'
+require 'faraday'
+require 'rack'
+require 'sapoci'
+require 'active_support/core_ext'
+options = OpenStruct.new
+parser = OptionParser.new do |opts|
+  opts.on("-d", "--[no-]debug", "Show raw response") do |o|
+    options.debug = o
+  end
+  opts.on("-p", "--post", "Use POST instead of GET") do |o|
+    options.http_post = o
+  end
+  opts.separator ""
+  opts.separator "Common options:"
+  opts.on_tail("-?", "-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+begin
+  parser.parse!(ARGV)
+  # Parameters
+  url = ARGV[0]
+  keywords = ARGV[1]
+  # Parse URL and query parameters
+  uri = URI.parse(url)
+  params = Rack::Utils.parse_query(uri.query) if uri.query
+  uri.query = nil
+  # Setup
+  conn = Faraday.new(uri.to_s, :ssl => {:verify => true}) do |builder|
+    builder.use SAPOCI::Connect::Middleware::FollowRedirects
+    builder.use SAPOCI::Connect::Middleware::PassCookies
+    builder.use SAPOCI::Connect::Middleware::BackgroundSearch
+    builder.use Faraday::Response::Logger if options.debug
+    builder.adapter :net_http
+  end
+  # Execute
+  method = options.http_post ? :post : :get
+  resp = SAPOCI::Connect.search(method, conn, keywords, "http://return.to/me", params)
+  if resp.status == 200
+    doc = resp.env[:sapoci]
+    $stdout.puts "%3s %-15s %-30s %s" % ["Idx", "Vendormat", "Description", "Price per unit"]
+    $stdout.puts "".ljust(98, '-')
+    doc.items.each do |item|
+      $stdout.puts "%3s %-15s %-30s %10.3f %-3s per %9.2f %-3s" % [item.index, item.vendormat, item.description, item.price, item.currency, item.priceunit, item.unit]
+      $stdout.puts "    %s" % [item.longtext]
+    end
+    $stdout.puts "===> #{doc.items.size} items"
+    $stdout.puts resp.body.to_s if options.debug
+    exit 0
+  elsif resp.status == 404
+    $stdout.puts "Not found (HTTP status #{resp.status})"
+    $stdout.puts resp.body.to_s if options.debug
+    exit 1
+  elsif resp.status == 500
+    $stdout.puts "Server crashed (HTTP status #{resp.status})"
+    $stdout.puts resp.body.to_s if options.debug
+    exit 1
+  else
+    $stdout.puts "Error: HTTP status code=#{resp.status}"
+    $stdout.puts resp.body.to_s if options.debug
+    exit 1
+  end
+rescue => e
+  $stderr.print "#{e.class}: " unless e.class == RuntimeError
+  $stderr.puts  e.message
+  $stderr.puts  e.backtrace
+  exit 1
+end

data/lib/sapoci/connect/middleware/background_search.rb ADDED Viewed

@@ -0,0 +1,22 @@
+module SAPOCI
+  module Connect
+    module Middleware
+      class BackgroundSearch < Faraday::Response::Middleware
+        def initialize(app, options = {})
+          @options = options
+          super(app)
+        end
+        def call(env)
+          @app.call(env).on_complete do |resp|
+            case env[:status]
+            when 200
+              env[:sapoci] = SAPOCI::Document.from_html(env[:body])
+            else
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sapoci/connect/middleware/follow_redirects.rb ADDED Viewed

@@ -0,0 +1,55 @@
+module SAPOCI
+  module Connect
+    module Middleware
+      class RedirectLimitReached < Faraday::Error::ClientError
+        attr_reader :response
+        def initialize(response)
+          super "too many redirects; last one to: #{response['location']}"
+          @response = response
+        end
+      end
+      class RedirectWithoutLocation < Faraday::Error::ClientError
+        attr_reader :response
+        def initialize(response)
+          super "redirect without setting HTTP Location header"
+          @response = response
+        end
+      end
+      class FollowRedirects < Faraday::Middleware
+        REDIRECTS    = [301, 302, 303]
+        FOLLOW_LIMIT = 5
+        def initialize(app, options = {})
+          super(app)
+          @options = options
+          @limit   = options[:limit] || FOLLOW_LIMIT
+        end
+        def call(env)
+          process(@app.call(env), @limit)
+        end
+        def process(response, limit)
+          response.on_complete do |env|
+            if redirect?(response)
+              raise RedirectLimitReached, response if limit.zero?
+              raise RedirectWithoutLocation, response if response['location'].blank?
+              env[:url] += response['location']
+              env[:method] = :get
+              response = process(@app.call(env), limit - 1)
+            end
+          end
+        end
+        def redirect?(response)
+          REDIRECTS.include? response.status
+        end
+      end
+    end
+  end
+end

data/lib/sapoci/connect/middleware/pass_cookies.rb ADDED Viewed

@@ -0,0 +1,25 @@
+module SAPOCI
+  module Connect
+    module Middleware
+      class PassCookies < Faraday::Response::Middleware
+        def initialize(app, options = {})
+          @options = options
+          @cookies = []
+          super(app)
+        end
+        def call(env)
+          unless @cookies.empty?
+            cookies = @cookies.compact.uniq.join("; ").squeeze(";")
+            env[:request_headers]['Cookie'] = cookies
+          end
+          @app.call(env).on_complete do |resp|
+            if cookie = resp[:response_headers]['Set-Cookie']
+              @cookies << cookie
+            end
+          end
+        end # call
+      end
+    end
+  end
+end

data/lib/sapoci/connect.rb ADDED Viewed

@@ -0,0 +1,54 @@
+require 'faraday'
+require 'sapoci'
+require 'sapoci/connect/middleware/follow_redirects'
+require 'sapoci/connect/middleware/pass_cookies'
+require 'sapoci/connect/middleware/background_search'
+module SAPOCI
+  module Connect
+    # Perform an OCI background search.
+    #
+    # If you need to follow redirects and pass cookies along, you should
+    # initialize and use Faraday with this pattern:
+    #
+    #   conn = Faraday.new("http://shop.com/path", :params => {"optional" => "value"}) do |builder|
+    #     builder.use SAPOCI::Connect::Middleware::FollowRedirects
+    #     builder.use SAPOCI::Connect::Middleware::PassCookies
+    #     builder.use SAPOCI::Connect::Middleware::BackgroundSearch
+    #     builder.adapter :net_http
+    #   end
+    #   conn.options[:timeout] = 3
+    #   conn.options[:open_timeout] = 5
+    #   resp = SAPOCI::Connect.search(:get, conn, "toner", "http://return.to/me")
+    #   puts resp.status # => 200
+    #   puts resp.body   # => <SAPOCI::Document>
+    #
+    def self.search(method, connection, keywords, hook_url, extra_params = nil)
+      params = {
+        "FUNCTION" => "BACKGROUND_SEARCH",
+        "SEARCHSTRING" => keywords,
+        "HOOK_URL" => hook_url
+      }
+      params.update(extra_params) if extra_params
+      unless connection.builder.handlers.include?(SAPOCI::Connect::Middleware::BackgroundSearch)
+        connection.use SAPOCI::Connect::Middleware::BackgroundSearch
+      end
+      case method.to_sym
+      when :get
+        connection.get do |req|
+          req.params = params
+        end
+      when :post
+        connection.post do |req|
+          req.body = Faraday::Utils.build_nested_query params
+        end
+      else
+        raise "SAPOCI::Connect.search only allows :get or :post requests"
+      end
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: sapoci-connect
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+  prerelease:
+platform: ruby
+authors:
+- Oliver Eilhard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70144890289320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144890289320
+- !ruby/object:Gem::Dependency
+  name: em-synchrony
+  requirement: &70144890288740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144890288740
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: &70144890288140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144890288140
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: &70144890287460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144890287460
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70144890286820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144890286820
+- !ruby/object:Gem::Dependency
+  name: sapoci
+  requirement: &70144890285840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144890285840
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70144890285160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70144890285160
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70144890284560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: *70144890284560
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70144890283900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70144890283900
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70144890283300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: *70144890283300
+description: HTTP client library for working with SAP OCI compliant servers.
+email:
+- oliver.eilhard@gmail.com
+executables:
+- sapoci-search
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+files:
+- bin/sapoci-search
+- lib/sapoci/connect.rb
+- lib/sapoci/connect/middleware/background_search.rb
+- lib/sapoci/connect/middleware/follow_redirects.rb
+- lib/sapoci/connect/middleware/pass_cookies.rb
+- CHANGELOG.md
+- LICENSE
+- README.md
+homepage: http://github.com/meplato/sapoci-connect
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+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:
+rubygems_version: 1.8.9
+signing_key:
+specification_version: 3
+summary: HTTP client library for working with SAP OCI compliant servers.
+test_files: []