frenetic 1.0.0.alpha.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc9d5efbe7083a07d49bc6d57da6a9ad2125e37d
-  data.tar.gz: 1d08f15fa29717b07f6bf43d6e46e8acc0832244
+  metadata.gz: c762ec3d9f1ece32685aa4e6e6acf19d02db55fe
+  data.tar.gz: 44c50996e3b1b7e8a8261d7d2919636383f0de70
 SHA512:
-  metadata.gz: ce6cdbdf561f06c6b4b9120b0222e69f031ea316f634e97f70df742a9c4015344ad551b6b60d072e149014ddd537def35ab6bbe7fbbd11367116fe7482527522
-  data.tar.gz: d70ca28073717ee35679abca5ef8107372ee7f3acf138070cdc40f91ef6a2b00481ddf49c5c76b9c6e6fcc86104e258c2f5407588d7b6c4b78abc1cb7e25a0de
+  metadata.gz: 17ca597ab9f13709f63067da856c157ae6505256ce9ec1f0feee51acb2be029c933da95fd6ce2868138f6fe0399824cf5755214845b914303685b2e2378ed539
+  data.tar.gz: 7d0571cd0e36780c57b4a9edd6e6d805fcfdbc0f0b58fddbc4b9258d642a2c5970d33ae7e3d9ff28f714c9c64fdb6abce317030a753f63a07505152df5687f58

data/.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -16,4 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-vendor
+vendor

data/.irbrc

@@ -1,3 +1,3 @@
 require 'bundler'
 Bundler.require
-require 'awesome_print'
+require 'awesome_print'

data/.rubocop.yml

@@ -0,0 +1,45 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+
+Metrics/ClassLength:
+  Max: 120
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/AccessModifierIndentation:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/ConstantName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/SpaceAfterColon:
+  Enabled: false
+
+Style/SpaceBeforeBlockBraces:
+  Enabled: false
+
+Style/SpaceInsideBlockBraces:
+  Enabled: false
+
+Style/SpaceInsideParens:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,3 @@
 rvm:
-  - 1.9.3
-script: bundle exec rspec --require spec_helper --order rand --color --format documentation
+  - 2.1.2
+script: bundle exec rspec --require spec_helper --order rand --color --format documentation

data/Appraisals

@@ -6,4 +6,4 @@ end
 appraise 'faraday-09' do
   gem 'faraday', '~> 0.9.0'
   gem 'faraday_middleware', '~> 0.9.0'
-end
+end

data/LICENSE

@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -139,7 +139,7 @@ Initializing an API client is really easy:
 class MyApiClient
   # Arbitrary example
   def self.api
-    @api ||= Frenetic.new( url:'http://example.com/api' )
+    @api ||= Frenetic.new(url:'http://example.com/api')
   end
 end
 ```
@@ -152,7 +152,7 @@ At the bare minimum, Frenetic only needs to know what the URL of your API is.
 Configuring Frenetic can be done during instantiation:
 
 ```ruby
-Frenetic.new( url:'http://example.com', api_token:'123bada55k3y' )
+Frenetic.new(url:'http://example.com', api_token:'123bada55k3y')
 ```
 
 Or with a block:
@@ -168,7 +168,7 @@ end
 Or both...
 
 ```ruby
-f = Frenetic.new( url:'http://example.com' )
+f = Frenetic.new(url:'http://example.com')
 f.configure do |cfg|
   cfg.api_token = '123bada55key'
 end
@@ -184,13 +184,13 @@ middleware.
 To use Basic Auth, simply configure Frenetic with a `username` and `password`:
 
 ```ruby
-Frenetic.new( url:url, username:'user', password:'password' )
+Frenetic.new(url:url, username:'user', password:'password')
 ```
 
 If your API uses an App ID and API Key pair, you can pass those as well:
 
 ```ruby
-Frenetic.new( url:url, app_id:'123abcSHA1', api_key:'bada55SHA1k3y' )
+Frenetic.new(url:url, app_id:'123abcSHA1', api_key:'bada55SHA1k3y')
 ```
 
 The `app_id` and `api_key` values are simply aliases to `username` and
@@ -201,7 +201,7 @@ The `app_id` and `api_key` values are simply aliases to `username` and
 To use Token Auth, simply configure Frenetic with your token:
 
 ```ruby
-Frenetic.new( url:url, api_token:'bada55SHA1t0k3n' )
+Frenetic.new(url:url, api_token:'bada55SHA1t0k3n')
 ```
 
 
@@ -214,7 +214,7 @@ If configured to do so, Frenetic will autotmatically cache API responses.
 ##### Rack::Cache
 
 ```ruby
-Frenetic.new( url:url, cache: :rack )
+Frenetic.new(url:url, cache: :rack)
 ```
 
 Passing in a cache option of `:rack` will cause Frenetic to use Faraday's
@@ -246,14 +246,14 @@ By default, Frenetic is configured to use Faraday's default adapter (usually
 Net::HTTP). You can change this with the `adapter` option:
 
 ```ruby
-Frenetic.new( url:url, adapter: :patron )
+Frenetic.new(url:url, adapter: :patron)
 ```
 
 Frenetic accepts any of the [Faraday adapter shortcuts][adapters], or an instance
 of the adapter itself:
 
 ```ruby
-Frenetic.new( url:url, adapter:Faraday::Adapter::Patron )
+Frenetic.new(url:url, adapter:Faraday::Adapter::Patron)
 ```
 
 
@@ -263,7 +263,7 @@ If you have no control over the API, you can explicitly tell Frenetic how long
 to cache the API description for:
 
 ```ruby
-Frenetic.new( url:url, default_root_cache_age:1.hour )
+Frenetic.new(url:url, default_root_cache_age:1.hour)
 ```
 
 
@@ -273,7 +273,7 @@ Frenetic.new( url:url, default_root_cache_age:1.hour )
 Frenetic will yield its internal Faraday connection during initialization:
 
 ```ruby
-Frenetic.new( url:url ) do |builder|
+Frenetic.new(url:url) do |builder|
   # `builder` is the Faraday Connection instance with which you can
   # add additional Faraday Middlewares or tweak the configuration.
 end
@@ -293,7 +293,7 @@ A Frenetic instance supports any HTTP verb that [Faraday][faraday] has
 impletented. This includes GET, POST, PUT, PATCH, and DELETE.
 
 ```ruby
-api = Frenetic.new( url:url )
+api = Frenetic.new(url:url)
 
 api.get '/my_things/1'
 # { 'id' => 1, 'name' => 'My Thing', '_links' => { 'self' { 'href' => '/api/my_things/1' } } }
@@ -314,8 +314,8 @@ class Order < Frenetic::Resource
   api_client { MyAPI }
 
   # TODO: Write a better example for this.
-  def self.find_all_by_name( name )
-    api.get( search_url(name) ) and response.success?
+  def self.find_all_by_name(name)
+    api.get(search_url(name)) and response.success?
   end
 end
 ```
@@ -411,7 +411,7 @@ stub out all of the HTTP requests with something like WebMock or VCR, or you can
 use Frenetic in `test_mode`
 
 ```ruby
-Frenetic.new( url:url, test_mode:true )
+Frenetic.new(url:url, test_mode:true)
 # ...or...
 api = Frenetic.new(url:url)
 api.config.test_mode = true

data/Rakefile

@@ -1,2 +1,2 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/gemfiles/faraday_08.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    frenetic (0.0.20.alpha.6)
+    frenetic (1.0.0)
       activesupport (>= 3)
       addressable (~> 2.3.4)
       faraday (>= 0.8)
@@ -10,11 +10,11 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.5)
-      i18n (~> 0.6, >= 0.6.9)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.3.6)
     appraisal (1.0.2)
@@ -31,9 +31,9 @@ GEM
       faraday (~> 0.8)
     faraday_middleware (0.8.8)
       faraday (>= 0.7.4, < 0.9)
-    i18n (0.6.11)
-    json (1.8.1)
-    minitest (5.4.1)
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.5.1)
     multipart-post (1.2.0)
     rack (1.5.2)
     rack-cache (1.2)
@@ -53,7 +53,7 @@ GEM
     rspec-support (3.0.4)
     safe_yaml (1.0.3)
     thor (0.19.1)
-    thread_safe (0.3.4)
+    thread_safe (0.3.5)
     timecop (0.7.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)

data/gemfiles/faraday_09.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    frenetic (0.0.20.alpha.6)
+    frenetic (1.0.0)
       activesupport (>= 3)
       addressable (~> 2.3.4)
       faraday (>= 0.8)
@@ -10,11 +10,11 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (4.1.5)
-      i18n (~> 0.6, >= 0.6.9)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.3.6)
     appraisal (1.0.2)
@@ -31,9 +31,9 @@ GEM
       faraday (~> 0.8)
     faraday_middleware (0.9.1)
       faraday (>= 0.7.4, < 0.10)
-    i18n (0.6.11)
-    json (1.8.1)
-    minitest (5.4.1)
+    i18n (0.7.0)
+    json (1.8.2)
+    minitest (5.5.1)
     multipart-post (2.0.0)
     rack (1.5.2)
     rack-cache (1.2)
@@ -53,7 +53,7 @@ GEM
     rspec-support (3.0.4)
     safe_yaml (1.0.3)
     thor (0.19.1)
-    thread_safe (0.3.4)
+    thread_safe (0.3.5)
     timecop (0.7.1)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)

data/lib/frenetic.rb

@@ -17,6 +17,8 @@ class Frenetic
   include ActiveSupport::Configurable
   include BrieflyMemoizable
 
+  MaxAge = /max-age=(?<max_age>\d+)/
+
   config_accessor :adapter
   config_accessor :api_token
   config_accessor :cache
@@ -49,12 +51,12 @@ class Frenetic
     url: nil,
     username: nil
   }
-  self.config.merge!(@@defaults)
+  config.merge!(@@defaults)
 
   # PENDING: [ActiveSupport4] Remove merge with class defaults
   def initialize(cfg = {})
-    self.config.merge!(cfg.reverse_merge(self.class.config))
-    yield self.config if block_given?
+    config.merge!(cfg.reverse_merge(self.class.config))
+    yield config if block_given?
   end
 
   def connection
@@ -74,10 +76,10 @@ class Frenetic
   #
   # If no Cache-Control header is returned, then the results are not memoized.
   def description
-    if response = get(config.url.to_s) and response.success?
-      @description_age = cache_control_age(response.headers)
-      response.body
-    end
+    response = get(config.url.to_s)
+    return unless response.success?
+    @description_age = cache_control_age(response.headers)
+    response.body
   end
   briefly_memoize :description
 
@@ -92,11 +94,12 @@ class Frenetic
 private
 
   def cache_control_age(headers)
-    if cache_age = headers['Cache-Control']
-      age = cache_age.match(%r{max-age=(?<max_age>\d+)})[:max_age]
+    cache_age = headers['Cache-Control']
+    if cache_age
+      age = cache_age.match(MaxAge)[:max_age]
       Time.now + age.to_i
     else
       config.default_root_cache_age
     end
   end
-end
+end

data/lib/frenetic/briefly_memoizable.rb

@@ -8,14 +8,15 @@ class Frenetic
     extend ActiveSupport::Concern
 
     module ClassMethods
-      def briefly_memoize( symbol )
+      def briefly_memoize(symbol)
         original_method = "_unmemoized_#{symbol}".to_sym
-        memoized_ivar   = "@#{symbol}"
-        age_ivar        = "@#{symbol}_age"
+        memoized_ivar = "@#{symbol}"
+        age_ivar = "@#{symbol}_age"
 
-        class_eval <<-EOS
+        # rubocop:disable Metrics/LineLength
+        class_eval <<-CODE
           if method_defined?(:#{original_method})                                  # if method_defined?(:_unmemoized_mime_type)
-            raise "Already memoized #{symbol}"                                     #   raise "Already memoized mime_type"
+            fail "Already memoized #{symbol}"                                      #   fail "Already memoized mime_type"
           end                                                                      # end
           alias #{original_method} #{symbol}                                       # alias _unmemoized_mime_type mime_type
 
@@ -27,8 +28,9 @@ class Frenetic
           def reload_#{symbol}!                                                    # def reload_mime_type!
             #{memoized_ivar} = nil                                                 #   @mime_type = nil
           end                                                                      # end
-        EOS
+        CODE
+        # rubocop:enable Metrics/LineLength
       end
     end
   end
-end
+end

data/lib/frenetic/concerns/collection_rest_methods.rb

@@ -4,10 +4,9 @@ class Frenetic
   module CollectionRestMethods
     extend ActiveSupport::Concern
 
-    def get( id )
-      if response = api.get( member_url(id) ) and response.success?
-        @resource_class.new response.body
-      end
+    def get(id)
+      response = api.get(member_url(id))
+      @resource_class.new(response.body) if response.success?
     end
   end
-end
+end

data/lib/frenetic/concerns/hal_linked.rb

@@ -10,10 +10,11 @@ class Frenetic
       @params['_links']
     end
 
-    def member_url( params = {} )
+    def member_url(params = {})
       resource = @resource_type || self.class.to_s.demodulize.underscore
-      link = links[resource] || links['self'] or raise HypermediaError, %Q{No Hypermedia GET Url found for the resource "#{resource}"}
-      HypermediaLinkSet.new( link ).href params
+      link = links[resource] || links['self']
+      fail MissingResourceUrl.new(resource) if !link
+      HypermediaLinkSet.new(link).href params
     end
 
     module ClassMethods
@@ -21,15 +22,17 @@ class Frenetic
         api.description['_links']
       end
 
-      def member_url( params = {} )
-        link = links[namespace] or raise HypermediaError, %Q{No Hypermedia GET Url found for the resource "#{namespace}"}
-        HypermediaLinkSet.new( link ).href params
+      def member_url(params = {})
+        link = links[namespace]
+        fail MissingResourceUrl.new(namespace) if !link
+        HypermediaLinkSet.new(link).href params
       end
 
       def collection_url
-        link = links[namespace.pluralize] or raise HypermediaError, %Q{No Hypermedia GET Url found for the resource "#{namespace.pluralize}"}
-        HypermediaLinkSet.new( link ).href
+        link = links[namespace.pluralize]
+        fail MissingResourceUrl.new(namespace.pluralize) if !link
+        HypermediaLinkSet.new(link).href
       end
     end
   end
-end
+end