frodata 0.9.1 → 0.9.2b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95944116dffa1ce9127d4836d239f21e1344952a
-  data.tar.gz: 9078d6e3859ff61e1c7300806a9603c23783be33
+  metadata.gz: 3dedcb00937ab1990ed95efd42b3e8642cf5455b
+  data.tar.gz: 9bb87a5f001789cf7faab8601890b46a61af8145
 SHA512:
-  metadata.gz: 7969fbe5c4b221bbb47cd270f9247754d286dd55c13cba397e80c6c4149674e2e2086dede8699f6ad1775d230d030c268ffa0ce684966c9755c2cdedbf28f303
-  data.tar.gz: cbdc81d7bb914049756edb595e8dc306a3e0551cd945bef1bffcd7f7bbfcff23c3952ae4c96034949b480c0e51bf9527f0d79baa866cc071571e4fdf9da0a081
+  metadata.gz: ef9e60b6641d846ce4fff2eb0a8f942ed059034f963c78517a6d506aad2116f50bbd7567a0dd4f8e35c2cc87c189399686870fc1a76d386f2697f46947fbb98b
+  data.tar.gz: d013d2fff11d0134354583fe232cbc10c3bff5b3fe885b25951e48ee1f1415157ad475c6879f122ddd2a5d4b3452615e3334ce982b6c3f5a23eb7cf70fd50379

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+rspec:
+  image: ruby:2.2
+  script:
+    - bundle install --path /cache --jobs $(nproc)
+    - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+    - chmod +x ./cc-test-reporter
+    - ./cc-test-reporter before-build
+    - bundle exec rspec  
+    - ./cc-test-reporter after-build --exit-code $?

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG
 
+## 0.9.2b
+
+* Fix broken stack traces in response errors
+* Ensure that `Service#service_url` always returns a string
+
+## 0.9.2
+
+* Ignore connection options when connection object is passed in
+* Don't send `Accept` header unless explicitly configured
+* Use middleware for request/response logging
+* Specifying an adapter is no longer necessary when passing a block to the constructor
+
 ## 0.9.1
 
 * [New] Raising specific error classes instead of `RuntimeError` when request fails

data/README.md

@@ -1,4 +1,4 @@
-# FrOData
+# FrOData - Free OData V4.0 library for Ruby
 
 The FrOData gem provides a simple wrapper around the OData Version 4.0 API protocol.
 It has the ability to automatically inspect compliant APIs and expose the relevant Ruby objects dynamically.
@@ -8,12 +8,11 @@ It also provides a set of code generation tools for quickly bootstrapping more c
 
 If you need a gem to integration with OData Version 3, you can use James Thompson's [original OData gem][ruby-odata], upon which this gem is based.
 
+[![Gem Version](https://badge.fury.io/rb/frodata.svg)](https://badge.fury.io/rb/frodata)
 [![Build Status](https://app.codeship.com/projects/da1eb540-ce3f-0135-2ddc-161d5c3cc5fd/status?branch=master)](https://app.codeship.com/projects/262148)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f151944dc05b2c7268e5/maintainability)](https://codeclimate.com/github/wrstudios/frodata/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/f151944dc05b2c7268e5/test_coverage)](https://codeclimate.com/github/wrstudios/frodata/test_coverage)
-[![Dependency Status](https://gemnasium.com/badges/github.com/wrstudios/frodata.svg)](https://gemnasium.com/github.com/wrstudios/frodata)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2425311d859408ef8798/maintainability)](https://codeclimate.com/github/wrstudios/frodata/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/2425311d859408ef8798/test_coverage)](https://codeclimate.com/github/wrstudios/frodata/test_coverage)
 [![Documentation](http://inch-ci.org/github/wrstudios/frodata.png?branch=master)](http://www.rubydoc.info/github/wrstudios/frodata/master)
-[![Gem Version](https://badge.fury.io/rb/frodata.svg)](https://badge.fury.io/rb/frodata)
 
 ## Installation
 
@@ -106,7 +105,7 @@ This allows you to e.g. set custom headers (such as `Authorization`) that may be
 
 ##### Using Authentication Helpers
 
-You may also set up authorization by directly accessing the underlying `Faraday::Connection` object (as explained in [Advanced Customization](#advanced-connection-customization) below).
+You may also set up authorization by directly accessing the underlying `Faraday::Connection` object `yield`ed to the constructor (as explained in [Advanced Customization](#advanced-connection-customization) below).
 This allows you to make use of Faraday's [authentication helpers][faraday-auth], such as `basic_auth` or `token_auth`.
 
 For instance, if your service requires HTTP basic authentication:
@@ -114,12 +113,11 @@ For instance, if your service requires HTTP basic authentication:
 ```ruby
   service = FrOData::Service.new('http://services.odata.org/V4/OData/OData.svc', {
     name: 'ODataDemo'
-  })
-  service.connection.basic_auth('username', 'password')
+  }) do |conn|
+    conn.basic_auth('username', 'password')
+  end
 ```
 
-You may also use these helpers when passing a block to the constructor (see second example [below](#passing-a-block-to-the-constructor)).
-
 [http-auth]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication
 [faraday]: https://github.com/lostisland/faraday
 [faraday-auth]: https://github.com/lostisland/faraday#authentication
@@ -144,6 +142,8 @@ In this case, you'll be setting the service URL on the connection object, as sho
   service = FrOData::Service.new(conn, name: 'ODataDemo')
 ```
 
+**NOTE**: if you use this method, any options set via the `:connection` options key will be ignored.
+
 ##### Passing a block to the constructor
 
 Alternatively, the connection object is also `yield`ed by the constructor, so you may customize it by passing a block argument.
@@ -157,21 +157,6 @@ For instance, if you wanted to use [Typhoeus][typhoeus] as your HTTP library:
   end
 ```
 
-**IMPORTANT**
-
-Please be aware that if you use this method to customize the connection, you must ALWAYS specify an adapter:
-
-```ruby
-  service = FrOData::Service.new('http://services.odata.org/V4/OData/OData.svc', {
-    name: 'ODataDemo'
-  }) do |conn|
-    conn.basic_auth('username', 'password')
-    conn.adapter Faraday.default_adapter
-  end
-```
-
-Otherwise, your requests WILL fail!
-
 [typhoeus]: https://github.com/typhoeus/typhoeus
 
 ### Exploring a Service
@@ -395,14 +380,6 @@ You should refer to the published RubyDocs for full details on the various capab
  * [FrOData::Query](http://rubydoc.info/github/wrstudios/frodata/master/FrOData/Query)
  * [FrOData::Query::Criteria](http://rubydoc.info/github/wrstudios/frodata/master/FrOData/Query/Criteria)
 
-## To Do
-
-[x] ~Lenient property validation~
-[ ] Write support (create/update/delete)
-[ ] Support for invoking [Operations][odata-ops] (Functions/Actions)
-[ ] [Property facets][odata-facets]
-[ ] Annotations
-
 [odata-facets]: http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part3-csdl/odata-v4.0-errata03-os-part3-csdl-complete.html#_Toc453752528
 [odata-ops]: http://docs.oasis-open.org/odata/odata/v4.0/errata03/os/complete/part1-protocol/odata-v4.0-errata03-os-part1-protocol-complete.html#_Toc453752307
 

data/lib/frodata/errors.rb

@@ -8,6 +8,7 @@ module FrOData
     attr_reader :response
 
     def initialize(response, message = nil)
+      super(message)
       @message  = message
       @response = response
     end

data/lib/frodata/service.rb

@@ -31,14 +31,14 @@ module FrOData
     # @param options [Hash] options to pass to the service
     # @return [FrOData::Service] an instance of the service
     def initialize(service_url, options = {}, &block)
+      @options = default_options.merge(options)
       if service_url.is_a? Faraday::Connection
         @connection  = service_url
-        @service_url = connection.url_prefix
+        @service_url = connection.url_prefix.to_s
       else
         @service_url = service_url
-        @connection  = Faraday.new(service_url, options[:connection], &block)
+        @connection  = default_connection(&block)
       end
-      @options     = default_options.merge(options)
       FrOData::ServiceRegistry.add(self)
       register_custom_types
     end
@@ -151,6 +151,7 @@ module FrOData
     # @param options [Hash] additional request options
     # @return [FrOData::Service::Response]
     def execute(url_chunk, options = {})
+      options = (@options[:request] || {}).merge(options)
       Request.new(self, url_chunk, options).execute
     end
 
@@ -225,6 +226,15 @@ module FrOData
       end
     end
 
+    def default_connection(&block)
+      Faraday.new(service_url, options[:connection]) do |conn|
+        conn.request :url_encoded
+        conn.response :logger, logger
+        yield conn if block_given?
+        conn.adapter Faraday.default_adapter unless conn.builder.send(:adapter_set?)
+      end
+    end
+
     def read_metadata
       # From file, good for debugging
       if options[:metadata_file]

data/lib/frodata/service/request.rb

@@ -44,12 +44,9 @@ module FrOData
 
       # Execute the request
       #
-      # @param additional_options [Hash] Request options to pass to Faraday
+      # @param request_options [Hash] Request options to pass to Faraday
       # @return [FrOData::Service::Response]
-      def execute(additional_options = {})
-        request_options = service.options[:request].merge(additional_options)
-
-        logger.info "Requesting #{method.to_s.upcase} #{url}..."
+      def execute(request_options = {})
         Response.new(service, query) do
           connection.run_request(method, url_chunk, nil, headers) do |conn|
             conn.options.merge! request_options
@@ -61,14 +58,8 @@ module FrOData
 
       attr_reader :url_chunk
 
-      def connection
-        service.connection
-      end
-
       def default_headers
         {
-          'Accept'        => content_type,
-          'Content-Type'  => content_type,
           'OData-Version' => '4.0'
         }
       end
@@ -77,6 +68,10 @@ module FrOData
         default_headers.merge(@options[:headers] || {})
       end
 
+      def connection
+        service.connection
+      end
+
       def logger
         service.logger
       end

data/lib/frodata/service/response.rb

@@ -96,7 +96,7 @@ module FrOData
       # @return [self]
       def validate_response!
         if error = FrOData::Errors::ERROR_MAP[status]
-          raise error, response, error_message
+          raise error.new(response, error_message)
         end
       end
 
@@ -104,11 +104,6 @@ module FrOData
 
       def execute(&block)
         @response = block.call
-        logger.debug <<-EOS
-          [FrOData: #{service.name}] Received response:
-            Headers: #{response.headers}
-            Body: #{response.body}
-        EOS
         check_content_type
         validate_response!
       rescue Faraday::TimeoutError

data/lib/frodata/version.rb

@@ -1,3 +1,3 @@
 module FrOData
-  VERSION = '0.9.1'
+  VERSION = '0.9.2b'
 end

data/spec/frodata/service_spec.rb

@@ -27,6 +27,7 @@ describe FrOData::Service, vcr: {cassette_name: 'service_specs'} do
       connection = Faraday.new(service_url)
       service = FrOData::Service.new(connection)
       expect(service.connection).to eq(connection)
+      expect(service.service_url).to eq(service_url)
     end
 
     it 'allows connection to be customized via options hash' do
@@ -36,10 +37,19 @@ describe FrOData::Service, vcr: {cassette_name: 'service_specs'} do
       expect(service.connection.headers).to include('X-Custom-Header' => 'foo')
     end
 
+    it 'ignores connection options when connetion is passed in' do
+      connection = Faraday.new(service_url, {
+        headers: { 'X-Custom-Header' => 'foo' }
+      })
+      service = FrOData::Service.new(connection, connection: {
+        headers: { 'X-Custom-Header' => 'bar' }
+      })
+      expect(service.connection.headers).to include('X-Custom-Header' => 'foo')
+    end
+
     it 'allows connection to be customized via block argument' do
       service = FrOData::Service.new(service_url) do |conn|
         conn.headers['X-Custom-Header'] = 'foo'
-        conn.adapter Faraday.default_adapter
       end
       expect(service.connection.headers).to include('X-Custom-Header' => 'foo')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frodata
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2b
 platform: ruby
 authors:
 - Christoph Wagner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -189,6 +189,7 @@ extra_rdoc_files: []
 files:
 - ".autotest"
 - ".gitignore"
+- ".gitlab-ci.yml"
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
@@ -328,9 +329,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14