excon-hypermedia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb36e9f12e5909b7e4d4321184f39582882da139
+  data.tar.gz: 3b6c39402e531bd8055c75a032aba0db380c6635
+SHA512:
+  metadata.gz: 759eedec55a1da3d4aced37c4385dcafb38c44ba1e4636222398251808ac6972b52dc5962d471ee3547032605d204f7c2bff3e12d3395f1f6dfd82b3e41f08dc
+  data.tar.gz: 08371cb0d025c67159f85481d2e2ef61cea5b8cb08e0dbf28917cd434f3fccdfb84ceaa0cef2af56d1a2f818c7b9f426f0fdd005731abb4b6ca66fb6b9b65e97

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/.wercker/
+/Gemfile.lock
+/pkg/

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - '.wercker/**/*'
+
+Metrics/LineLength:
+  Max: 100

data/.wercker.yml

@@ -0,0 +1,7 @@
+box: ruby:2.3
+build:
+  steps:
+  - bundle-install
+  - script:
+    name: tests
+    code: bundle exec rake

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jean@mertz.fm. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jean Mertz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 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.

data/README.md

@@ -0,0 +1,85 @@
+# Excon::Hypermedia
+
+Teaches [Excon][] how to talk to [HyperMedia APIs][hypermedia].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'excon-hypermedia'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install excon-hypermedia
+```
+
+## Usage
+
+**NOTE**: This library is in very early development. Right now, it only talks
+the `HAL/JSON` protocol, and it only knows how to follow (non-curie) link
+relations. It returns raw response bodies in string format.
+
+This gem adds a thin layer on top of [Excon][excon] to make it talk with an
+HyperMedia-enabled API. To let Excon know the connection supports HyperMedia,
+simply add the `hypermedia: true` option.
+
+```ruby
+conn = Excon.new('http://www.example.com/api.json', hypermedia: true)
+conn.class # => Excon::Connection
+```
+
+From that point on, you can use this single connection to make all requests. The
+`hypermedia` option will be passed on to all subsequent connection objects, as
+long as you keep chaining the requests from the original top-level connection.
+
+```ruby
+product = conn.product(expand: { uid: 'hello' })
+product.class # => Excon::Connection
+
+response = product.get
+response.class # => Excon::Response
+response.body.class # => String
+```
+
+As seen above, you can expand URI Template variables using the `expand` option,
+provided by the [`excon-addressable` library][excon-addressable].
+
+You can mark any connection object as hypermedia-aware – not just the top-level
+entrypoint – by passing in the `hypermedia: true` option:
+
+```ruby
+user = Excon.new('http://www.example.com/users/jeanmertz', hypermedia: true)
+user.orders.class # => Excon::Connection
+```
+
+Since each new resource is simply an `Excon::Connection` object, all
+[Excon-provided options][options] are available as well:
+
+```ruby
+product.get(idempotent: true, retry_limit: 6)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## TODO
+
+* use Excon's Middleware system
+* make it easy to access attributes in response objects
+* properly handle curied-links and/or non-valid Ruby method name links
+* work correctly with Excon.get/post/delete shortcut methods
+
+[excon]: https://github.com/excon/excon
+[hypermedia]: https://en.wikipedia.org/wiki/HATEOAS
+[excon-addressable]: https://github.com/JeanMertz/excon-addressable
+[options]: https://github.com/excon/excon#options

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options = %w(--display-cop-names --extra-details --display-style-guide)
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: %i(test rubocop)

data/excon-hypermedia.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'excon/hypermedia/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'excon-hypermedia'
+  spec.version       = Excon::Hypermedia::VERSION
+  spec.authors       = %w(Jean Mertz)
+  spec.email         = %w(jean@mertz.fm)
+
+  spec.summary       = 'Excon, with Hypermedia traversing baked in.'
+  spec.description   = 'Excon, with Hypermedia traversing baked in.'
+  spec.homepage      = 'https://github.com/JeanMertz/excon-hypermedia'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.40'
+  spec.add_development_dependency 'pry', '~> 0.10'
+
+  spec.add_dependency 'excon', '~> 0.49'
+  spec.add_dependency 'excon-addressable', '~> 0.1'
+end

data/lib/excon/hypermedia.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+require 'excon'
+require 'excon/addressable'
+require 'excon/hypermedia/hyper_media'
+
+# :nodoc:
+module Excon
+  # HyperMedia addition to Excon.
+  #
+  module Hypermedia
+    def new(url, params = {})
+      params[:hypermedia] ? super.extend(HyperMedia) : super
+    end
+  end
+
+  singleton_class.prepend Hypermedia
+end

data/lib/excon/hypermedia/hyper_media.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'json'
+
+module Excon
+  # HyperMedia
+  #
+  module HyperMedia
+    def method_missing(method_name, *params)
+      return super unless (url = entrypoint.dig('_links', method_name.to_s, 'href'))
+
+      Excon.new(url, params.first.to_h.merge(hypermedia: true))
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      entrypoint.dig('_links', method_name.to_s, 'href') ? true : super
+    end
+
+    private
+
+    def entrypoint
+      @entrypoint ||= JSON.parse(get.body)
+    rescue JSON::ParserError
+      {}
+    end
+  end
+end

data/lib/excon/hypermedia/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Excon
+  module Hypermedia
+    VERSION = '0.1.0'
+  end
+end

data/test/excon/hypermedia_test.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+# rubocop:disable Metrics/AbcSize, Metrics/LineLength
+require_relative '../test_helper'
+
+module Excon
+  # HypermediaTest
+  #
+  # Verifies the Excon connection consuming HyperMedia APIs.
+  #
+  class HypermediaTest < Minitest::Test
+    def entrypoint
+      <<~EOF
+        {
+          "_links": {
+            "hello": {
+              "href":"http://www.example.com/hello/{location}"
+            }
+          }
+        }
+      EOF
+    end
+
+    def hello_world
+      <<~EOF
+        {
+          "_links": {
+            "goodbye": {
+              "href":"http://www.example.com/hello/world/goodbye{?message}"
+            }
+          }
+        }
+      EOF
+    end
+
+    def hello_universe
+      <<~EOF
+        {
+          "_links": {
+            "goodbye": {
+              "href":"http://www.example.com/hello/universe/goodbye{?message}"
+            }
+          }
+        }
+      EOF
+    end
+
+    def setup
+      Excon.defaults[:mock] = true
+
+      Excon.stub({ method: :get, path: '/api' }, body: entrypoint, status: 200)
+      Excon.stub({ method: :get, path: '/hello/world' }, body: hello_world, status: 200)
+      Excon.stub({ method: :get, path: '/hello/world/goodbye', query: nil }, body: 'bye!', status: 200)
+      Excon.stub({ method: :get, path: '/hello/world/goodbye', query: 'message=farewell' }, body: 'farewell', status: 200)
+      Excon.stub({ method: :get, path: '/hello/universe' }, body: hello_universe, status: 200)
+    end
+
+    def test_hypermedia_request
+      conn = Excon.new('http://www.example.com/api', hypermedia: true)
+      conn2 = conn.hello(expand: { location: 'world' })
+      conn3 = conn.hello(expand: { location: 'universe' })
+
+      assert_equal '/hello/world', conn2.data[:path]
+      assert conn2.get.body.include?('http://www.example.com/hello/world/goodbye{?message}')
+
+      assert_equal '/hello/universe', conn3.data[:path]
+      assert conn3.get.body.include?('http://www.example.com/hello/universe/goodbye{?message}')
+    end
+
+    def test_nested_hypermedia_request
+      conn = Excon.new('http://www.example.com/api', hypermedia: true)
+      conn2 = conn.hello(expand: { location: 'world' }).goodbye
+      conn3 = conn.hello(expand: { location: 'world' }).goodbye(expand: { message: 'farewell' })
+
+      assert_equal '/hello/world/goodbye', conn2.data[:path]
+      assert_nil conn2.data[:query]
+      assert_equal 'bye!', conn2.get.body
+
+      assert_equal '/hello/world/goodbye', conn3.data[:path]
+      assert_equal 'message=farewell', conn3.data[:query]
+      assert_equal 'farewell', conn3.get.body
+    end
+
+    def teardown
+      Excon.stubs.clear
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'excon/hypermedia'
+require 'minitest/autorun'

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: excon-hypermedia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean
+- Mertz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: excon-addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Excon, with Hypermedia traversing baked in.
+email:
+- jean@mertz.fm
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".wercker.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- excon-hypermedia.gemspec
+- lib/excon/hypermedia.rb
+- lib/excon/hypermedia/hyper_media.rb
+- lib/excon/hypermedia/version.rb
+- test/excon/hypermedia_test.rb
+- test/test_helper.rb
+homepage: https://github.com/JeanMertz/excon-hypermedia
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Excon, with Hypermedia traversing baked in.
+test_files: []
+has_rdoc: