frenetic 0.0.20.alpha.6 → 1.0.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc9d5efbe7083a07d49bc6d57da6a9ad2125e37d
+  data.tar.gz: 1d08f15fa29717b07f6bf43d6e46e8acc0832244
+SHA512:
+  metadata.gz: ce6cdbdf561f06c6b4b9120b0222e69f031ea316f634e97f70df742a9c4015344ad551b6b60d072e149014ddd537def35ab6bbe7fbbd11367116fe7482527522
+  data.tar.gz: d70ca28073717ee35679abca5ef8107372ee7f3acf138070cdc40f91ef6a2b00481ddf49c5c76b9c6e6fcc86104e258c2f5407588d7b6c4b78abc1cb7e25a0de

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p374
+2.1.2

data/Appraisals

@@ -0,0 +1,9 @@
+appraise 'faraday-08' do
+  gem 'faraday', '~> 0.8.0'
+  gem 'faraday_middleware', '~> 0.8.0'
+end
+
+appraise 'faraday-09' do
+  gem 'faraday', '~> 0.9.0'
+  gem 'faraday_middleware', '~> 0.9.0'
+end

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-ruby '1.9.3'
+ruby '2.1.2'
 
 # Specify your gem's dependencies in frenetic.gemspec
 gemspec

data/README.md

@@ -176,7 +176,7 @@ end
 
 #### Authentication
 
-Frenetic supports both Basic Auth and Tokens Auth via the appropriate Faraday
+Frenetic supports both Basic Auth and Token Auth via the appropriate Faraday
 middleware.
 
 ##### Basic Auth
@@ -457,4 +457,4 @@ ideas on how to support other Hypermedia formats like [Collection+JSON][coll_jso
 [root_cache]: #default-root-cache-age
 [adapters]: https://github.com/lostisland/faraday/blob/c26a060acdd9eae356409c2ca79f1c22f8263de9/lib/faraday/adapter.rb#L7-L17
 [rack_cache]: https://github.com/rtomayko/rack-cache
-[coll_json]: http://amundsen.com/media-types/collection/
+[coll_json]: http://amundsen.com/media-types/collection/

data/frenetic.gemspec

@@ -14,15 +14,18 @@ Gem::Specification.new do |gem|
   gem.name          = "frenetic"
   gem.require_paths = ["lib"]
   gem.version       = Frenetic::VERSION
+  gem.required_ruby_version = '>= 1.9.3'
 
-  gem.add_dependency             'faraday',             '~> 0.8.7'
-  gem.add_dependency             'faraday_middleware',  '~> 0.9.0'
+  gem.add_dependency             'faraday',             '>= 0.8'
+  gem.add_dependency             'faraday_middleware',  '>= 0.8'
   gem.add_dependency             'activesupport',       '>= 3'
   gem.add_dependency             'addressable',         '~> 2.3.4'
 
   gem.add_development_dependency 'awesome_print'
-  gem.add_development_dependency 'rspec',               '~> 2.13.0'
+  gem.add_development_dependency 'rspec',               '~> 3.0.0'
   gem.add_development_dependency 'rack-cache',          '~> 1.2'
-  gem.add_development_dependency 'webmock',             '~> 1.11.0'
-  gem.add_development_dependency 'timecop',             '~> 0.6.1'
+  gem.add_development_dependency 'faraday-http-cache',  '~> 0.4.2'
+  gem.add_development_dependency 'webmock',             '~> 1.18.0'
+  gem.add_development_dependency 'timecop',             '~> 0.7.1'
+  gem.add_development_dependency 'appraisal',           '~> 1.0.2'
 end

data/gemfiles/faraday_08.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+ruby "2.1.2"
+
+gem "faraday", "~> 0.8.0"
+gem "faraday_middleware", "~> 0.8.0"
+
+gemspec :path => "../"

data/gemfiles/faraday_08.gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: ../
+  specs:
+    frenetic (0.0.20.alpha.6)
+      activesupport (>= 3)
+      addressable (~> 2.3.4)
+      faraday (>= 0.8)
+      faraday_middleware (>= 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    awesome_print (1.2.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    faraday-http-cache (0.4.2)
+      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)
+    multipart-post (1.2.0)
+    rack (1.5.2)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    safe_yaml (1.0.3)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    timecop (0.7.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 1.0.2)
+  awesome_print
+  faraday (~> 0.8.0)
+  faraday-http-cache (~> 0.4.2)
+  faraday_middleware (~> 0.8.0)
+  frenetic!
+  rack-cache (~> 1.2)
+  rspec (~> 3.0.0)
+  timecop (~> 0.7.1)
+  webmock (~> 1.18.0)

data/gemfiles/faraday_09.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+ruby "2.1.2"
+
+gem "faraday", "~> 0.9.0"
+gem "faraday_middleware", "~> 0.9.0"
+
+gemspec :path => "../"

data/gemfiles/faraday_09.gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: ../
+  specs:
+    frenetic (0.0.20.alpha.6)
+      activesupport (>= 3)
+      addressable (~> 2.3.4)
+      faraday (>= 0.8)
+      faraday_middleware (>= 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.5)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    appraisal (1.0.2)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    awesome_print (1.2.0)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (0.4.2)
+      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)
+    multipart-post (2.0.0)
+    rack (1.5.2)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    safe_yaml (1.0.3)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    timecop (0.7.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.18.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 1.0.2)
+  awesome_print
+  faraday (~> 0.9.0)
+  faraday-http-cache (~> 0.4.2)
+  faraday_middleware (~> 0.9.0)
+  frenetic!
+  rack-cache (~> 1.2)
+  rspec (~> 3.0.0)
+  timecop (~> 0.7.1)
+  webmock (~> 1.18.0)

data/lib/frenetic.rb

@@ -1,44 +1,69 @@
 require 'socket'
 require 'faraday'
 require 'faraday_middleware'
+require 'active_support/configurable'
+require 'active_support/core_ext/hash/reverse_merge'
 
 require 'frenetic/version'
-require 'frenetic/concerns/configurable'
-require 'frenetic/concerns/briefly_memoizable'
+require 'frenetic/errors'
+require 'frenetic/briefly_memoizable'
+require 'frenetic/connection'
 require 'frenetic/middleware/hal_json'
 require 'frenetic/resource'
 require 'frenetic/resource_collection'
 
 class Frenetic
   extend Forwardable
-  include Configurable
+  include ActiveSupport::Configurable
   include BrieflyMemoizable
 
-  def_delegators :connection, :get, :put, :post, :delete
-
-  Error           = Class.new(StandardError)
-  ConfigError     = Class.new(Error)
-  ClientError     = Class.new(Error)
-  ServerError     = Class.new(Error)
-  ParsingError    = Class.new(Error)
-  HypermediaError = Class.new(Error)
+  config_accessor :adapter
+  config_accessor :api_token
+  config_accessor :cache
+  config_accessor :default_root_cache_age
+  config_accessor :headers
+  config_accessor :middleware
+  config_accessor :password
+  config_accessor :ssl
+  config_accessor :test_mode
+  config_accessor :url
+  config_accessor :username
+
+  def_delegators :connection, :delete, :get, :head, :options, :patch, :post, :put
+
+  # Can't explicitly use config_accessor because we need defaults and
+  # ActiveSupport < 4 does not support them
+  @@defaults = {
+    adapter: Faraday.default_adapter,
+    api_token: nil,
+    cache: false,
+    default_root_cache_age: nil,
+    headers: {
+      accept: 'application/hal+json',
+      user_agent: "Frenetic v#{Frenetic::VERSION}; #{Socket.gethostname}"
+    },
+    middleware: [],
+    password: nil,
+    ssl: { verify:true },
+    test_mode: false,
+    url: nil,
+    username: nil
+  }
+  self.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?
+  end
 
   def connection
-    @connection ||= begin
-      validate_configuration!
-
-      Faraday.new( config ) do |builder|
-        configure_authentication builder
-
-        builder.response :hal_json
-
-        configure_caching builder
-
-        @builder_config.call( builder ) if @builder_config
+    @connection ||= Connection.new(config)
+  end
 
-        builder.adapter config.adapter
-      end
-    end
+  # PENDING: [ActiveSupport4] Use super.
+  def configure
+    yield(config).tap { reset_connection! }
   end
 
   # Since Frenetic needs to frequently refer to the API design, the result of
@@ -49,9 +74,8 @@ 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 )
-
+    if response = get(config.url.to_s) and response.success?
+      @description_age = cache_control_age(response.headers)
       response.body
     end
   end
@@ -61,12 +85,15 @@ class Frenetic
     description['_embedded']['schema']
   end
 
+  def reset_connection!
+    @connection = nil
+  end
+
 private
 
-  def cache_control_age( headers )
+  def cache_control_age(headers)
     if cache_age = headers['Cache-Control']
       age = cache_age.match(%r{max-age=(?<max_age>\d+)})[:max_age]
-
       Time.now + age.to_i
     else
       config.default_root_cache_age

data/lib/frenetic/briefly_memoizable.rb

@@ -0,0 +1,34 @@
+require 'active_support/concern'
+
+# Memoizes method calls, but only for a specific period of time.
+# Useful for supporting HTTP Cache-Control without an external caching layer
+# like Rack::Cache
+class Frenetic
+  module BrieflyMemoizable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def briefly_memoize( symbol )
+        original_method = "_unmemoized_#{symbol}".to_sym
+        memoized_ivar   = "@#{symbol}"
+        age_ivar        = "@#{symbol}_age"
+
+        class_eval <<-EOS
+          if method_defined?(:#{original_method})                                  # if method_defined?(:_unmemoized_mime_type)
+            raise "Already memoized #{symbol}"                                     #   raise "Already memoized mime_type"
+          end                                                                      # end
+          alias #{original_method} #{symbol}                                       # alias _unmemoized_mime_type mime_type
+
+          def #{symbol}(*args)                                                     # def mime_type(*args)
+            #{memoized_ivar} = nil if #{age_ivar} && Time.now > #{age_ivar}        #   @mime_type = nil if @mime_type_age && Time.now > @mime_type_age
+            #{memoized_ivar} ||= #{original_method}(*args)                         #   @mime_type ||= _unmemoized_mime_type(*args)
+          end                                                                      # end
+
+          def reload_#{symbol}!                                                    # def reload_mime_type!
+            #{memoized_ivar} = nil                                                 #   @mime_type = nil
+          end                                                                      # end
+        EOS
+      end
+    end
+  end
+end

data/lib/frenetic/concerns/collection_rest_methods.rb

@@ -10,4 +10,4 @@ class Frenetic
       end
     end
   end
-end
+end

data/lib/frenetic/concerns/hal_linked.rb

@@ -1,5 +1,6 @@
 require 'active_support/concern'
-require 'addressable/template'
+
+require 'frenetic/hypermedia_link_set'
 
 class Frenetic
   module HalLinked
@@ -11,10 +12,8 @@ class Frenetic
 
     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}"}
-
-      self.class.parse_link link, params
+      HypermediaLinkSet.new( link ).href params
     end
 
     module ClassMethods
@@ -24,42 +23,13 @@ class Frenetic
 
       def member_url( params = {} )
         link = links[namespace] or raise HypermediaError, %Q{No Hypermedia GET Url found for the resource "#{namespace}"}
-
-        parse_link link, params
+        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}"}
-
-        link['href']
-      end
-
-      def parse_link( link, params = {} )
-        if link['templated']
-          expand_link link, params
-        else
-          link['href']
-        end
-      end
-
-    private
-
-      def expand_link( link, params )
-        tmpl = Addressable::Template.new link['href']
-
-        if params && !params.is_a?(Hash)
-          params = infer_url_template_values tmpl, params
-        end
-
-        tmpl.expand( params ).to_s
+        HypermediaLinkSet.new( link ).href
       end
-
-      def infer_url_template_values( tmpl, params )
-        key = tmpl.variables.first
-
-        { key => params }
-      end
-
     end
   end
 end