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

sapoci-connect 0.1.7 → 0.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

data/CHANGELOG.md +22 -0
data/LICENSE +1 -1
data/README.md +6 -5
data/bin/sapoci-search +19 -4
data/lib/sapoci/connect.rb +11 -6
data/lib/sapoci/connect/middleware/background_search.rb +5 -12
data/lib/sapoci/connect/middleware/follow_redirects.rb +114 -14
metadata +51 -47
data/lib/sapoci/connect/middleware/pass_cookies.rb +0 -25

data/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,25 @@
+*2012-05-03 (0.1.9)*
+* Require Faraday version 0.8.0 or later.
+* Fixed handling of HTTP GET on HTTP redirect, especially 302:
+  There was a problem with echoing the body with HTTP GET, which
+  some proxies don't like (Squid).
+* Fixed cookie handling: Some clients replace cookie values in
+  subsequent requests and, up until now, we simply concatenated
+  them.
+* Used middleware from FaradayMiddleware project, but changed/fixed
+  some issues, e.g. cookie handling and handling the case where
+  a client wants to redirect, but does not provide a Location header.
+*2012-02-08 (0.1.8)*
+* Hardened sapoci-search and put up a banner in optparse
+* Updated sapoci gem to 0.1.7: Accept (and replace) comma by dot in
+  numeric fields
+* Timeout by Faraday is special: `Faraday::Error::TimeoutError`
+  instead of `Timeout::Error`
 *2011-10-15 (0.1.7)*
 * Accept GET and POST on ./bin/sapoci-search

data/LICENSE CHANGED Viewed

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2011 Oliver Eilhard
+Copyright (c) 2007-2012 Oliver Eilhard
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md CHANGED Viewed

@@ -10,10 +10,9 @@ comply to the SAP OCI 4.0 specification.
 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
+      builder.response :follow_redirects, :cookies => :all, :limit => 5
+      builder.response :background_search
+      builder.adapter  :net_http
     end
     conn.options[:timeout] = 5
@@ -25,7 +24,7 @@ It's as simple as this:
     puts resp.env[:raw_body]   # => "<html>...</html>"
 Review [Faraday](https://github.com/technoweenie/faraday) for details on
-connection initiation.
+connection initiation. We require Faraday version 0.8.0 or later.
 ## Testing
@@ -46,6 +45,8 @@ To test external servers, use the REMOTE environment variable:
 Standing on the shoulder of giants, where giants include:
 * Rick Olson for [faraday](https://github.com/technoweenie/faraday),
+* Erik Michaels-Ober, Wynn Netherland, et al. for
+  [faraday_middleware](https://github.com/pengwynn/faraday_middleware),
 * 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)

data/bin/sapoci-search CHANGED Viewed

@@ -13,6 +13,8 @@ require 'active_support/core_ext'
 options = OpenStruct.new
 parser = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$0} [options] url keywords"
   opts.on("-d", "--[no-]debug", "Show raw response") do |o|
     options.debug = o
   end
@@ -20,6 +22,10 @@ parser = OptionParser.new do |opts|
   opts.on("-p", "--post", "Use POST instead of GET") do |o|
     options.http_post = o
   end
+  opts.on("-P", "--proxy [uri]", "Set proxy server URI") do |uri|
+    options.proxy_uri = uri
+  end
   opts.separator ""
   opts.separator "Common options:"
@@ -33,6 +39,12 @@ end
 begin
   parser.parse!(ARGV)
+  # url and keyword required
+  if ARGV.size < 2
+    puts parser.to_s
+    exit 1
+  end
   # Parameters
   url = ARGV[0]
   keywords = ARGV[1]
@@ -44,13 +56,16 @@ begin
   # 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.response :follow_redirects, :cookies => :all, :limit => 5
+    builder.response :background_search
     builder.use Faraday::Response::Logger if options.debug
-    builder.adapter :net_http
+    builder.adapter  Faraday.default_adapter
   end
+  # Respect proxy settings
+  options.proxy_uri ||= ENV['SAPOCI_PROXY_URI']
+  conn.proxy({:uri => options.proxy_uri}) if options.proxy_uri
   # Execute
   method = options.http_post ? :post : :get
   resp = SAPOCI::Connect.search(method, conn, keywords, "http://return.to/me", params)

data/lib/sapoci/connect.rb CHANGED Viewed

@@ -1,22 +1,27 @@
 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
+    # Register Faraday middleware
+    if Faraday.respond_to?(:register_middleware)
+      Faraday.register_middleware :response,
+        :follow_redirects  => lambda { SAPOCI::Connect::Middleware::FollowRedirects },
+        :background_search => lambda { SAPOCI::Connect::Middleware::BackgroundSearch }
+    end
     # 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
+    #     builder.response :follow_redirects, :cookies => :all, :limit => 5, :standards_compliant => true
+    #     builder.response :background_search
+    #     builder.adapter  Faraday.default_adapter
     #   end
     #   conn.options[:timeout] = 3
     #   conn.options[:open_timeout] = 5
@@ -33,7 +38,7 @@ module SAPOCI
       params.update(extra_params) if extra_params
       unless connection.builder.handlers.include?(SAPOCI::Connect::Middleware::BackgroundSearch)
-        connection.use SAPOCI::Connect::Middleware::BackgroundSearch
+        connection.response :background_search
       end
       case method.to_sym

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

@@ -2,18 +2,11 @@ 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
+        def on_complete(env)
+          case env[:status]
+          when 200
+            env[:sapoci] = SAPOCI::Document.from_html(env[:body])
+          else
           end
         end
       end

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

@@ -1,6 +1,10 @@
+require 'faraday'
+require 'set'
 module SAPOCI
   module Connect
     module Middleware
+      # Public: Exception thrown when the maximum amount of requests is exceeded.
       class RedirectLimitReached < Faraday::Error::ClientError
         attr_reader :response
@@ -10,43 +14,139 @@ module SAPOCI
         end
       end
+      # Public: Exception thrown when client returns an empty location header
       class RedirectWithoutLocation < Faraday::Error::ClientError
         attr_reader :response
         def initialize(response)
-          super "redirect without setting HTTP Location header"
+          super "redirect with empty location header"
           @response = response
         end
       end
+      # Public: Follow HTTP 301, 302, 303, and 307 redirects for GET, PATCH, POST,
+      # PUT, and DELETE requests.
+      #
+      # This middleware does not follow the HTTP specification for HTTP 302, by
+      # default, in that it follows the improper implementation used by most major
+      # web browsers which forces the redirected request to become a GET request
+      # regardless of the original request method.
+      #
+      # For HTTP 301, 302, and 303, the original request is transformed into a
+      # GET request to the response Location, by default. However, with standards
+      # compliance enabled, a 302 will instead act in accordance with the HTTP
+      # specification, which will replay the original request to the received
+      # Location, just as with a 307.
+      #
+      # For HTTP 307, the original request is replayed to the response Location,
+      # including original HTTP request method (GET, POST, PUT, DELETE, PATCH),
+      # original headers, and original body.
+      #
+      # This middleware currently only works with synchronous requests; in other
+      # words, it doesn't support parallelism.
       class FollowRedirects < Faraday::Middleware
-        REDIRECTS    = [301, 302, 303]
-        FOLLOW_LIMIT = 5
+        # HTTP methods for which 30x redirects can be followed
+        ALLOWED_METHODS = Set.new [:get, :post, :put, :patch, :delete]
+        # HTTP redirect status codes that this middleware implements
+        REDIRECT_CODES  = Set.new [301, 302, 303, 307]
+        # Keys in env hash which will get cleared between requests
+        ENV_TO_CLEAR    = Set.new [:status, :response, :response_headers]
+        # Default value for max redirects followed
+        FOLLOW_LIMIT = 3
+        # Public: Initialize the middleware.
+        #
+        # options - An options Hash (default: {}):
+        #           limit - A Numeric redirect limit (default: 3)
+        #           standards_compliant - A Boolean indicating whether to respect
+        #                                 the HTTP spec when following 302
+        #                                 (default: false)
+        #          cookie - Use either an array of strings
+        #                  (e.g. ['cookie1', 'cookie2']) to choose kept cookies
+        #                  or :all to keep all cookies.
         def initialize(app, options = {})
           super(app)
           @options = options
-          @limit   = options[:limit] || FOLLOW_LIMIT
+          @replay_request_codes = Set.new [307]
+          @replay_request_codes << 302 if standards_compliant?
         end
         def call(env)
-          process(@app.call(env), @limit)
+          perform_with_redirection(env, follow_limit)
         end
-        def process(response, limit)
+        private
+        def transform_into_get?(response)
+          !@replay_request_codes.include? response.status
+        end
+        def perform_with_redirection(env, follows)
+          request_body = env[:body]
+          response = @app.call(env)
           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)
+            if follow_redirect?(env, response)
+              raise RedirectLimitReached, response if follows.zero?
+              env = update_env(env, request_body, response)
+              response = perform_with_redirection(env, follows - 1)
+            end
+          end
+          response
+        end
+        def update_env(env, request_body, response)
+          location = response['location']
+          raise RedirectWithoutLocation, response if location.blank?
+          env[:url] += location
+          if @options[:cookies] && captured_cookies = keep_cookies(env)
+            env[:request_headers]['Cookie'] = captured_cookies
+          end
+          if transform_into_get?(response)
+            env[:method] = :get
+            env[:body] = nil
+          else
+            env[:body] = request_body
+          end
+          ENV_TO_CLEAR.each {|key| env.delete key }
+          env
+        end
+        def follow_redirect?(env, response)
+          ALLOWED_METHODS.include? env[:method] and
+            REDIRECT_CODES.include? response.status
+        end
+        def follow_limit
+          @options.fetch(:limit, FOLLOW_LIMIT)
+        end
+        def keep_cookies(env)
+          cookies = @options.fetch(:cookies, [])
+          response_cookies = env[:response_headers]['Set-Cookie'] #[:cookies]
+          cookies == :all ? response_cookies : selected_request_cookies(response_cookies)
+        end
+        def selected_request_cookies(cookies)
+          selected_cookies(cookies)[0...-1]
+        end
+        def selected_cookies(cookies)
+          "".tap do |cookie_string|
+            @options[:cookies].each do |cookie|
+              string = /#{cookie}=?[^;]*/.match(cookies)[0] + ';'
+              cookie_string << string
             end
           end
         end
-        def redirect?(response)
-          REDIRECTS.include? response.status
+        def standards_compliant?
+          @options.fetch(:standards_compliant, false)
         end
       end
     end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sapoci-connect
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
   prerelease:
 platform: ruby
 authors:
@@ -9,55 +9,38 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-10-15 00:00:00.000000000 Z
+date: 2012-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70144890289320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.7.4
+        version: 0.8.0
   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
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *70144890288140
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
-  name: typhoeus
-  requirement: &70144890287460 !ruby/object:Gem::Requirement
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 1.1.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70144890287460
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: &70144890286820 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,23 +49,25 @@ dependencies:
     - - <
       - !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
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.7
   type: :runtime
   prerelease: false
-  version_requirements: *70144890285840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70144890285160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,10 +75,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70144890285160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70144890284560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,10 +91,15 @@ dependencies:
         version: '2.5'
   type: :development
   prerelease: false
-  version_requirements: *70144890284560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70144890283900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -112,10 +107,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70144890283900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70144890283300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -123,7 +123,12 @@ dependencies:
         version: '1.2'
   type: :development
   prerelease: false
-  version_requirements: *70144890283300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: HTTP client library for working with SAP OCI compliant servers.
 email:
 - oliver.eilhard@gmail.com
@@ -139,7 +144,6 @@ files:
 - 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
@@ -164,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project:
-rubygems_version: 1.8.9
+rubygems_version: 1.8.23
 signing_key:
 specification_version: 3
 summary: HTTP client library for working with SAP OCI compliant servers.

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

@@ -1,25 +0,0 @@
-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