prx_hyperresource 1.0.0

data/lib/hyper_resource.rb

@@ -0,0 +1,243 @@
+require "hyper_resource/attributes"
+require "hyper_resource/configuration"
+require "hyper_resource/exceptions"
+require "hyper_resource/link"
+require "hyper_resource/links"
+require "hyper_resource/objects"
+require "hyper_resource/version"
+
+require "hyper_resource/adapter"
+require "hyper_resource/adapter/hal_json"
+
+require "hyper_resource/modules/data_type"
+require "hyper_resource/modules/deprecations"
+require "hyper_resource/modules/http"
+require "hyper_resource/modules/config_attributes"
+require "hyper_resource/modules/internal_attributes"
+
+require "rubygems" if RUBY_VERSION[0..2] == "1.8"
+
+require "pp"
+
+## HyperResource is the main resource base class.  Normally it will be used
+## through subclassing, though it may also be used directly.
+
+class HyperResource
+  include HyperResource::Modules::ConfigAttributes
+  include HyperResource::Modules::DataType
+  include HyperResource::Modules::Deprecations
+  include HyperResource::Modules::InternalAttributes
+  include Enumerable
+
+  private
+
+  DEFAULT_HEADERS = {"Accept" => "application/json"}
+
+  public
+
+  ## Create a new HyperResource, given a hash of options.  These options
+  ## include:
+  ##
+  ## [root]  The root URL of the resource.
+  ##
+  ## [auth]  Authentication information.  Currently only +{basic:
+  ##         ['key', 'secret']}+ is supported.
+  ##
+  ## [namespace] Class or class name, into which resources should be
+  ##             instantiated.
+  ##
+  ## [headers] Headers to send along with requests for this resource (as
+  ##           well as its eventual child resources, if any).
+  ##
+  ## [faraday_options] Configuration passed to +Faraday::Connection.initialize+,
+  ##                   such as +{request: {timeout: 30}}+.
+  ##
+  def initialize(opts = {})
+    self.root = opts[:root] if opts[:root]
+    self.href = opts[:href] if opts[:href]
+
+    self.hr_config = self.class.hr_config.clone
+
+    self.adapter = opts[:adapter] if opts[:adapter]
+    self.faraday_options = opts[:faraday_options] if opts[:faraday_options]
+    self.auth = opts[:auth] if opts[:auth]
+
+    self.headers = DEFAULT_HEADERS
+      .merge(self.class.headers || {})
+      .merge(opts[:headers] || {})
+
+    self.namespace = opts[:namespace] if opts[:namespace]
+    if !namespace && self.class != HyperResource
+      self.namespace = self.class.namespace || self.class.to_s
+    end
+
+    ## There's a little acrobatics in getting Attributes, Links, and Objects
+    ## into the correct subclass.
+    if self.class != HyperResource
+      if self.class::Attributes == HyperResource::Attributes
+        Object.module_eval(
+          "class #{self.class}::Attributes < HyperResource::Attributes; end", __FILE__, __LINE__
+        )
+      end
+      if self.class::Links == HyperResource::Links
+        Object.module_eval(
+          "class #{self.class}::Links < HyperResource::Links; end", __FILE__, __LINE__
+        )
+      end
+      if self.class::Objects == HyperResource::Objects
+        Object.module_eval(
+          "class #{self.class}::Objects < HyperResource::Objects; end", __FILE__, __LINE__
+        )
+      end
+    end
+
+    self.attributes = self.class::Attributes.new(self)
+    self.links = self.class::Links.new(self)
+    self.objects = self.class::Objects.new(self)
+    self.loaded = false
+  end
+
+  ## Creates a new resource given args :link, :resource, :href, :response, :url,
+  ## and :body.  Either :link or (:resource and :href and :url) are required.
+  # @private
+  def self.new_from(args)
+    link = args[:link]
+    resource = args[:resource] || link.resource
+    href = begin
+      args[:href] || link.href
+    rescue
+      nil
+    end
+    url = args[:url] || URI.join(resource.root, href || "")
+    response = args[:response]
+    body = args[:body] || {}
+
+    old_rsrc = resource
+    new_class = old_rsrc.get_data_type_class(resource: old_rsrc,
+      link: link,
+      url: url,
+      response: response,
+      body: body)
+    new_rsrc = new_class.new(root: old_rsrc.root,
+      href: href)
+    new_rsrc.hr_config = old_rsrc.hr_config.clone
+    new_rsrc.response = response
+    new_rsrc.body = body
+    new_rsrc.adapter.apply(body, new_rsrc)
+    new_rsrc.loaded = true
+    new_rsrc
+  end
+
+  # @private
+  def new_from(args)
+    self.class.new_from(args)
+  end
+
+  ## Returns true if one or more of this object's attributes has been
+  ## reassigned.
+  def changed?(*args)
+    attributes.changed?(*args)
+  end
+
+  #### Filters
+
+  ## +incoming_body_filter+ filters a hash of attribute keys and values
+  ## on their way from a response body to a HyperResource.  Override this
+  ## in a subclass of HyperResource to implement filters on incoming data.
+  def incoming_body_filter(attr_hash)
+    attr_hash
+  end
+
+  ## +outgoing_body_filter+ filters a hash of attribute keys and values
+  ## on their way from a HyperResource to a request body.  Override this
+  ## in a subclass of HyperResource to implement filters on outgoing data.
+  def outgoing_body_filter(attr_hash)
+    attr_hash
+  end
+
+  ## +outgoing_uri_filter+ filters a hash of attribute keys and values
+  ## on their way from a HyperResource to a URL.  Override this
+  ## in a subclass of HyperResource to implement filters on outgoing URI
+  ## parameters.
+  def outgoing_uri_filter(attr_hash)
+    attr_hash
+  end
+
+  #### Enumerable support
+
+  ## Returns the *i*th object in the first collection of objects embedded
+  ## in this resource.  Returns nil on failure.
+  def [](i)
+    get unless loaded
+    begin
+      objects.first[1][i]
+    rescue
+      nil
+    end
+  end
+
+  ## Iterates over the objects in the first collection of embedded objects
+  ## in this resource.
+  def each(&block)
+    get unless loaded
+    begin
+      objects.first[1].each(&block)
+    rescue
+      nil
+    end
+  end
+
+  #### Magic
+
+  ## method_missing will load this resource if not yet loaded, then
+  ## attempt to delegate to +attributes+, then +objects+, then +links+.
+  ## Override with extreme care.
+  def method_missing(method, *args) # standard:disable Style/MissingRespondToMissing
+    ## If not loaded, load and retry.
+    unless loaded
+      return get.send(method, *args)
+    end
+
+    ## Otherwise, try to match against attributes, then objects, then links.
+    method = method.to_s
+    if method[-1, 1] == "="
+      return attributes[method[0..-2]] = args.first if attributes&.has_key?(method[0..-2])
+    else
+      return attributes[method] if attributes&.has_key?(method.to_s)
+      return objects[method] if objects && objects[method]
+      if links && links[method]
+        if args.count > 0
+          return links[method].where(*args)
+        else
+          return links[method]
+        end
+      end
+    end
+
+    raise NoMethodError, "undefined method `#{method}' for #{inspect}"
+  end
+
+  ## respond_to? is patched to return +true+ if +method_missing+ would
+  ## successfully delegate a method call to +attributes+, +links+, or
+  ## +objects+.
+  def respond_to?(method, *args)
+    return true if links&.respond_to?(method)
+    return true if attributes&.respond_to?(method)
+    return true if objects&.respond_to?(method)
+    super
+  end
+
+  def inspect # @private
+    "#<#{self.class}:0x#{"%x" % object_id} @root=#{root.inspect} " \
+      "@href=#{href.inspect} @loaded=#{loaded} " \
+      "@namespace=#{namespace.inspect} ...>"
+  end
+
+  def self.user_agent # @private
+    "HyperResource #{HyperResource::VERSION}"
+  end
+
+  def user_agent # @private
+    self.class.user_agent
+  end
+end

data/lib/hyperresource.rb

@@ -0,0 +1 @@
+require "hyper_resource"

data/lib/prx_hyperresource.rb

@@ -0,0 +1 @@
+require "hyper_resource"

metadata

@@ -0,0 +1,220 @@
+--- !ruby/object:Gem::Specification
+name: prx_hyperresource
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pete Gamache
+- Andrew Kuklewicz - PRX
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.0.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      HyperResource is a hypermedia client library for Ruby.  Its goals are to
+      interface directly with well-behaved hypermedia APIs, to allow the data
+      returned from these APIs to optionally be extended by client-side code,
+      and to present a modern replacement for ActiveResource.
+email: andrew@prx.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/hyper_resource.rb
+- lib/hyper_resource/adapter.rb
+- lib/hyper_resource/adapter/hal_json.rb
+- lib/hyper_resource/attributes.rb
+- lib/hyper_resource/configuration.rb
+- lib/hyper_resource/exceptions.rb
+- lib/hyper_resource/link.rb
+- lib/hyper_resource/links.rb
+- lib/hyper_resource/modules/config_attributes.rb
+- lib/hyper_resource/modules/data_type.rb
+- lib/hyper_resource/modules/deprecations.rb
+- lib/hyper_resource/modules/http.rb
+- lib/hyper_resource/modules/internal_attributes.rb
+- lib/hyper_resource/objects.rb
+- lib/hyper_resource/version.rb
+- lib/hyperresource.rb
+- lib/prx_hyperresource.rb
+homepage: https://github.com/PRX/hyperresource
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/PRX/hyperresource
+  changelog_uri: https://github.com/PRX/hyperresource/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Extensible hypermedia client for Ruby
+test_files: []