fmrest 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 996b7a73eb92f7a6d7df2b0e6f7a5f082005dc258b5ab2ba5589967e9c87b60e
-  data.tar.gz: 3ac6ecdcd60573186ca63bd30d32202ed33cb04884de8acc5bc572e13d8976f3
+  metadata.gz: b3b6d6aed0ef181daf2e8a254809704f09f65e6720f29adad829d028b7429322
+  data.tar.gz: 7d7007ff6968884ebb293e99ef901706d70a3c95721a893443cb16c9e69ac7da
 SHA512:
-  metadata.gz: a1f892950743e0ef1cdcaf5eccb51131f4de935c6b56b3a09e0893eb39f031b0d54830e34fc88624249f4ec29cebd8aa7993e3e52b0c99c9dfc35436a9150de6
-  data.tar.gz: 5d030409c8f51aec4bd4cae244e667be3bf758da672837893c3f34a6a82ec8d3e7f2b3461c54057a0849d63a9965bc800e5b7490510bd2e8ca4f50533064318e
+  metadata.gz: dd2ffd6cf2f3622b5efff65925dc5a73e3380a8270f0a6650898385620b144e2c8f7199d5512f1cce500bd973ca70e13440b5d219a6abeccb5c28b684b6a190f
+  data.tar.gz: ad43d73a77f18dc138b90400fc9b8213f61bce9b8659a7c84ba3c5cedeb00fcd2fca900a461125ef859263548dbf570f263b8212a698a990ab97adedffb6aff9

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## Changelog
+
+### 0.2.4
+
+* Use `String#=~` instead of `String#match?` for Ruby <2.4 compatibility (Fixes
+  [#26](https://github.com/beezwax/fmrest-ruby/issues/26))
+* Deprecate `FmRest.config` in favor of `FmRest.default_connection_settings`
+* Honor Faraday SSL and proxy settings when fetching container files

data/README.md

@@ -63,6 +63,42 @@ end
 For each request fmrest-ruby will first request a session token (using the
 provided username and password) if it doesn't yet have one in store.
 
+## Connection settings
+
+In addition to the required `:host`, `:database`, `:username` and `:password`
+connection options, you can also pass `:ssl` and `:proxy`, which are passed to
+the underlying [Faraday](https://github.com/lostisland/faraday) connection.
+
+You can use this to, for instance, disable SSL verification:
+
+```ruby
+FmRest::V1.build_connection(
+  host:     "example.com",
+  ...
+  ssl:      { verify: false }
+)
+```
+
+You can use the `:log` option for basic request logging, see the section on
+[Logging](#Logging) below.
+
+### Default connection settings
+
+If you're only connecting to a single FM database you can configure it globally
+through `FmRest.default_connection_settings=`. E.g.:
+
+```ruby
+FmRest.default_connection_settings = {
+  host:     "example.com",
+  database: "database name",
+  username: "username",
+  password: "password"
+}
+```
+
+This configuration will be used by default by `FmRest::V1.build_connection` as
+well as your models whenever you don't pass a configuration hash explicitly.
+
 ## Session token store
 
 By default fmrest-ruby will use a memory-based store for the session tokens.
@@ -556,11 +592,11 @@ for you automatically by Spyke (see [their
 README](https://github.com/balvig/spyke#log-output)).
 
 You can also enable simple STDOUT logging (useful for debugging) by passing
-`log: true` in the options hash for either `FmRest.config=` or your models'
-`fmrest_config=`, e.g.:
+`log: true` in the options hash for either
+`FmRest.default_connection_settings=` or your models' `fmrest_config=`, e.g.:
 
 ```ruby
-FmRest.config = {
+FmRest.default_connection_settings = {
   host:     "example.com",
   database: "My Database",
   username: "z3r0c00l",
@@ -580,8 +616,6 @@ class LoggyBee < FmRest::Spyke::Base
 end
 ```
 
-Note that the log option set in `FmRest.config` is ignored by models.
-
 If you need to set up more complex logging for your models can use the
 `faraday` block inside your class to inject your own logger middleware into the
 Faraday connection, e.g.:

data/lib/fmrest.rb

@@ -10,6 +10,20 @@ module FmRest
   class << self
     attr_accessor :token_store
 
-    attr_accessor :config
+    attr_writer :default_connection_settings
+
+    def default_connection_settings
+      @default_connection_settings || {}
+    end
+
+    def config=(connection_hash)
+      warn "[DEPRECATION] `FmRest.config=` is deprecated, use `FmRest.default_connection_settings=` instead"
+      self.default_connection_settings = connection_hash
+    end
+
+    def config
+      warn "[DEPRECATION] `FmRest.config` is deprecated, use `FmRest.default_connection_settings` instead"
+      default_connection_settings
+    end
   end
 end

data/lib/fmrest/spyke/container_field.rb

@@ -21,7 +21,7 @@ module FmRest
 
       # @return (see FmRest::V1::ContainerFields#fetch_container_data)
       def download
-        FmRest::V1.fetch_container_data(url)
+        FmRest::V1.fetch_container_data(url, @base.class.connection)
       end
 
       # @param filename_or_io [String, IO] a path to the file to upload or an

data/lib/fmrest/spyke/model/connection.rb

@@ -38,7 +38,7 @@ module FmRest
           private
 
           def fmrest_connection
-            @fmrest_connection ||= FmRest::V1.build_connection(fmrest_config || FmRest.config) do |conn|
+            @fmrest_connection ||= FmRest::V1.build_connection(fmrest_config || FmRest.default_connection_settings) do |conn|
               faraday_block.call(conn) if faraday_block
 
               # Pass the class to JsonParser's initializer so it can have

data/lib/fmrest/v1/connection.rb

@@ -9,7 +9,14 @@ module FmRest
     module Connection
       BASE_PATH = "/fmi/data/v1/databases".freeze
 
-      def build_connection(options = FmRest.config, &block)
+      # Builds a complete DAPI Faraday connection with middleware already
+      # configured to handle authentication, JSON parsing, logging and DAPI
+      # error handling. A block can be optionally given for additional
+      # middleware configuration
+      #
+      # @option (see #base_connection)
+      # @return (see #base_connection)
+      def build_connection(options = FmRest.default_connection_settings, &block)
         base_connection(options) do |conn|
           conn.use RaiseErrors
           conn.use TokenSession, options
@@ -37,7 +44,19 @@ module FmRest
         end
       end
 
-      def base_connection(options = FmRest.config, &block)
+      # Builds a base Faraday connection with base URL constructed from
+      # connection options and passes it the given block
+      #
+      # @option options [String] :host The hostname for the FM server
+      # @option options [String] :database The FM database name
+      # @option options [String] :username The username for DAPI authentication
+      # @option options [String] :password The password for DAPI authentication
+      # @option options [String] :ssl SSL options to forward to the Faraday
+      #   connection
+      # @option options [String] :proxy Proxy options to forward to the Faraday
+      #   connection
+      # @return [Faraday] The new Faraday connection
+      def base_connection(options = FmRest.default_connection_settings, &block)
         host = options.fetch(:host)
 
         # Default to HTTPS
@@ -50,7 +69,15 @@ module FmRest
           scheme = uri.scheme
         end
 
-        Faraday.new("#{scheme}://#{host}#{BASE_PATH}/#{URI.escape(options.fetch(:database))}/".freeze, &block)
+        faraday_options = {}
+        faraday_options[:ssl] = options[:ssl] if options.key?(:ssl)
+        faraday_options[:proxy] = options[:proxy] if options.key?(:proxy)
+
+        Faraday.new(
+          "#{scheme}://#{host}#{BASE_PATH}/#{URI.escape(options.fetch(:database))}/".freeze,
+          faraday_options,
+          &block
+        )
       end
     end
   end

data/lib/fmrest/v1/container_fields.rb

@@ -9,13 +9,20 @@ module FmRest
       # object with its body content (see Ruby's OpenURI for how the IO object
       # is extended with useful HTTP response information).
       #
-      # This method uses Net::HTTP and OpenURI instead of Faraday.
+      # This method uses OpenURI instead of Faraday for fetching the actual
+      # container file.
       #
       # @raise [FmRest::ContainerFieldError] if any step fails
-      # @param container_field_url [String] the URL to the container to
+      # @param container_field_url [String] The URL to the container to
       #   download
-      # @return [IO] the contents of the container
-      def fetch_container_data(container_field_url)
+      # @param base_connection [Faraday::Connection] An optional Faraday
+      #   connection to use as base settings for the container requests, useful
+      #   if you need to set SSL or proxy settings. If given, this connection
+      #   will not be used directly, but rather a new one with copied SSL and
+      #   proxy options. If omitted, `FmRest.default_connection_settings`'s
+      #   `:ssl` and `:proxy` options will be used instead (if available)
+      # @return [IO] The contents of the container
+      def fetch_container_data(container_field_url, base_connection = nil)
         require "open-uri"
 
         begin
@@ -29,25 +36,29 @@ module FmRest
           raise FmRest::ContainerFieldError, "Container URL is not HTTP (#{container_field_url})"
         end
 
-        require "net/http"
+        conn =
+          Faraday.new(nil,
+            ssl:   base_connection ? base_connection.ssl.to_hash : FmRest.default_connection_settings[:ssl],
+            proxy: base_connection ? base_connection.proxy.to_hash : FmRest.default_connection_settings[:proxy]
+          )
 
         # Requesting the container URL with no cookie set will respond with a
         # redirect and a session cookie
-        cookie_response = ::Net::HTTP.get_response(url)
+        cookie_response = conn.get url
 
-        unless cookie = cookie_response["Set-Cookie"]
+        unless cookie = cookie_response.headers["Set-Cookie"]
           raise FmRest::ContainerFieldError, "Container field's initial request didn't return a session cookie, the URL may be stale (try downloading it again immediately after retrieving the record)"
         end
 
         # Now request the URL again with the proper session cookie using
         # OpenURI, which wraps the response in an IO object which also responds
         # to #content_type
-        url.open("Cookie" => cookie)
+        url.open(faraday_connection_to_openuri_options(conn).merge("Cookie" => cookie))
       end
 
       # Handles the core logic of uploading a file into a container field
       #
-      # @param connection [Faraday] the Faraday connection to use
+      # @param connection [Faraday::Connection] the Faraday connection to use
       # @param container_path [String] the path to the container
       # @param filename_or_io [String, IO] a path to the file to upload or an
       #   IO object
@@ -68,6 +79,33 @@ module FmRest
           request.body = { upload: Faraday::UploadIO.new(filename_or_io, content_type, filename) }
         end
       end
+
+      private
+
+      # Copies a Faraday::Connection's relevant options to
+      # OpenURI::OpenRead#open format
+      #
+      def faraday_connection_to_openuri_options(conn)
+        openuri_opts = {}
+
+        if !conn.ssl.empty?
+          openuri_opts[:ssl_verify_mode] =
+            conn.ssl.fetch(:verify, true) ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+
+          openuri_opts[:ssl_ca_cert] = conn.ssl.cert_store if conn.ssl.cert_store
+        end
+
+        if conn.proxy && !conn.proxy.empty?
+          if conn.proxy.user && conn.proxy.password
+            openuri_opts[:proxy_http_basic_authentication] =
+              [conn.proxy.uri.tap { |u| u.userinfo = ""}, conn.proxy.user, conn.proxy.password]
+          else
+            openuri_opts[:proxy] = conn.proxy.uri
+          end
+        end
+
+        openuri_opts
+      end
     end
   end
 end

data/lib/fmrest/v1/token_session.rb

@@ -8,7 +8,7 @@ module FmRest
       HEADER_KEY = "Authorization".freeze
       TOKEN_STORE_INTERFACE = [:load, :store, :delete].freeze
 
-      def initialize(app, options = FmRest.config)
+      def initialize(app, options = FmRest.default_connection_settings)
         super(app)
         @options = options
       end
@@ -71,7 +71,7 @@ module FmRest
           begin
             # Strip the host part to just the hostname (i.e. no scheme or port)
             host = @options.fetch(:host)
-            host = URI(host).hostname if host.match?(/\Ahttps?:\/\//)
+            host = URI(host).hostname if host =~ /\Ahttps?:\/\//
             "#{host}:#{@options.fetch(:database)}"
           end
       end

data/lib/fmrest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FmRest
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fmrest
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Pedro Carbajal
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-12 00:00:00.000000000 Z
+date: 2019-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -188,6 +188,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt