hyperclient 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b87fcd7112fdf8f2cbb75b3e70d9eb63ed7c4d93
-  data.tar.gz: fbbb826d826c93579534fbe028d3669192f524f7
+  metadata.gz: 1bba91bc97f25344d522646fec5c34cb74b183d4
+  data.tar.gz: b8289075f6c69400d84da795751f404030b9fdaa
 SHA512:
-  metadata.gz: 05065d18d4c25d4c73c9e3023e3ab1710cb41a8750ee9ad4fef18deb69e08949492a2b67ad0a590170f39162c5ff8888b24b72b876d440c12ca4e1fdf98fd4fa
-  data.tar.gz: 33213521c2e8443cc70e4b48f6327dd83a58c9f016266d2af27f0774cd980b84bb69e98ad1733ffeadd446073a31014bbb2a822c81234d73eda345c247a3af81
+  metadata.gz: 26e276baa5ea49d3e54c47b308c12efad26bb259cacc620cab7b44d84ff61e17296b904ea738b3a7917044044e37653944ef854577335575bc6f5d1f46b4a767
+  data.tar.gz: 69d655ed12c311619476b43b595b7705ad69d590a960a356775b0cdb554c95f6b20d4a9b0f3dc34ee9b1281566a8aee3e5881de99f32a2d04321bf8eb9b6bee8

data/.gitignore

@@ -15,3 +15,4 @@ test/tmp
 test/version_tmp
 tmp
 examples/william.rb
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

@@ -0,0 +1,55 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-09-18 12:21:47 -0400 using RuboCop version 0.26.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 118
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 39
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 145
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 14
+
+# Offense count: 2
+Metrics/PerceivedComplexity:
+  Max: 9
+
+# Offense count: 1
+Style/AsciiComments:
+  Enabled: false
+
+# Offense count: 2
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Offense count: 14
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 3
+Style/Lambda:
+  Enabled: false
+
+# Offense count: 5
+# Configuration parameters: MaxSlashes.
+Style/RegexpLiteral:
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,5 @@
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.2
+

data/CHANGELOG.md

@@ -1,13 +1,36 @@
-== 0.3.1
-* backwards incompatible changes
-  * Nothing
+### 0.5.0 (October 1, 2014)
 
-* enhancements
-  * Support arrays of Links (by @rehevkor5)
-  * Created the CHANGELOG.
+This version introduces several backwards incompatible changes. See [UPGRADING](UPGRADING.md) for details.
 
-* bug fix
-  * Nothing
+* [#63](https://github.com/codegram/hyperclient/pull/63): Navigational methods, including `links`, `get` or `post`, have been renamed to `_links`, `_get`, or `_post` respectively - [@dblock](https://github.com/dblock).
+* [#64](https://github.com/codegram/hyperclient/issues/64): Added support for curies - [@dblock](https://github.com/dblock).
+* [#58](https://github.com/codegram/hyperclient/issues/58): Automatically follow redirects - [@dblock](https://github.com/dblock).
+* [#63](https://github.com/codegram/hyperclient/pull/63): You can omit the navigational elements, `api.links.products` is now equivalent to `api.products` - [@dblock](https://github.com/dblock).
+* [#61](https://github.com/codegram/hyperclient/pull/61): Implemented Rubocop, Ruby-style linter - [@dblock](https://github.com/dblock).
 
-* deprecations
-  * Nothing
+### 0.4.0 (May 5, 2014)
+
+* [#54](https://github.com/codegram/hyperclient/pull/54): Support Faraday 0.9.0 - [@lucianapazos](https://github.com/lucianapazos).
+* [#30](https://github.com/codegram/hyperclient/pull/30): Use futuroscope to run API calls in the background - [@josepjaume](https://github.com/josepjaume).
+
+### 0.3.2 (December 20, 2013)
+
+* [#48](https://github.com/codegram/hyperclient/pull/48): Added support for fetch on the collection class - [@col](https://github.com/col).
+* [#50](https://github.com/codegram/hyperclient/pull/50): Fixed Resource/Attributes mutating the response body - [@col](https://github.com/col).
+* [#46](https://github.com/codegram/hyperclient/pull/46): Made response available inside Resource, provide access to status codes - [@benhamill](https://github.com/benhamill).
+* [#43](https://github.com/codegram/hyperclient/pull/43): Fixed LinkCollection#include? - [@benhamill](https://github.com/benhamill).
+* [#47](https://github.com/codegram/hyperclient/pull/47): Fixed uninitialized constant Hyperclient::Resource::Forwardable - [@benhamill](https://github.com/benhamill).
+* [#39](https://github.com/codegram/hyperclient/pull/39): Exposed templated link properties - [@txus](https://github.com/txus).
+* [#38](https://github.com/codegram/hyperclient/pull/38): Defaulted POST, PUT and PATCH parameters - [@bkeepers](https://github.com/bkeepers).
+* [#37](https://github.com/codegram/hyperclient/pull/37): Fixed calling #flatten on an array of links - [@bkeepers](https://github.com/bkeepers).
+* [#36](https://github.com/codegram/hyperclient/pull/36): Exposed link properties - [@bkeepers](https://github.com/bkeepers).
+* [#31](https://github.com/codegram/hyperclient/pull/31): Allowed underscored attribute names other than the ones reserved by the HAL spec - [@karlin](https://github.com/karlin).
+* [#29](https://github.com/codegram/hyperclient/pull/29): Handled JSON that includes a link with a null value - [@arbylee](https://github.com/arbylee).
+
+### 0.3.1 (April 3, 2013)
+
+* [#27](https://github.com/codegram/hyperclient/pull/27): Added support for collections of links - [@rehevkor5](https://github.com/rehevkor5).
+
+### 0.3.0 (February 3, 2013)
+
+* Initial public release - [@oriolgual](https://github.com/oriolgual).

data/CONTRIBUTING.md

@@ -0,0 +1,117 @@
+Contributing to Hyperclient
+===========================
+
+Hyperclient is work of [many people](https://github.com/codegram/hyperclient/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/codegram/hyperclient/pulls), [propose features and discuss issues](https://github.com/codegram/hyperclient/issues).
+
+#### Fork the Project
+
+Fork the [project on Github](https://github.com/codegram/hyperclient) and check out your copy.
+
+```
+git clone https://github.com/contributor/hyperclient.git
+cd hyperclient
+git remote add upstream https://github.com/codegram/hyperclient.git
+```
+
+#### Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+#### Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+#### Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. Add to [test/hyperclient](test/hyperclient).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+#### Write Code
+
+Implement your feature or bug fix. Don't forget to update the [README](README.md).
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop), run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+#### Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+#### Push
+
+```
+git push origin my-feature-branch
+```
+
+#### Make a Pull Request
+
+Go to https://github.com/contributor/hyperclient and select your feature branch. Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+#### Update CHANGELOG
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/codegram/hyperclient/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+We like neat commits. Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Rebase
+
+If you've been working on a change for a while, rebase with upstream/master often.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+We like neat commits, please try to amend your previous commits and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+#### Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+#### Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+#### Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -11,5 +11,6 @@ gem 'pry'
 
 gem 'redcarpet'
 gem 'yard', '~> 0.8'
-gem 'yard-tomdoc', git: 'git://github.com/rubyworks/yard-tomdoc'
+gem 'yard-tomdoc'
 gem 'simplecov', require: false
+gem 'rubocop', '~> 0.26.0', require: false

data/Guardfile

@@ -1,13 +1,13 @@
 guard 'minitest' do
-  watch(%r|^test/(.*)_test\.rb|)
-  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
-  watch(%r|^(.*)([^/]+)\.rb|)         { |m| "test/#{m[1]}#{m[2]}_test.rb" }
-  watch(%r|^test/test_helper\.rb|)    { "test" }
+  watch(%r{^test/(.*)_test\.rb})
+  watch(%r{^lib/(.*)([^/]+)\.rb})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^(.*)([^/]+)\.rb})         { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb})    { 'test' }
 end
 
 guard 'spinach' do
-  watch(%r|^features/(.*)\.feature|)
-  watch(%r|^features/steps/(.*)([^/]+)\.rb|) do |m|
+  watch(%r{^features/(.*)\.feature})
+  watch(%r{^features/steps/(.*)([^/]+)\.rb}) do |m|
     "features/#{m[1]}#{m[2]}.feature"
   end
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Oriol Gual
+Copyright (c) 2012-214 Oriol Gual
 
 MIT 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

@@ -0,0 +1,138 @@
+# Hyperclient
+
+[![Build Status](https://secure.travis-ci.org/codegram/hyperclient.png)](http://travis-ci.org/codegram/hyperclient)
+[![Dependency Status](https://gemnasium.com/codegram/hyperclient.png)](http://gemnasium.com/codegram/hyperclient)
+[![Code Climate](https://codeclimate.com/github/codegram/hyperclient.png)](https://codeclimate.com/github/codegram/hyperclient)
+
+Hyperclient is a Hypermedia API client written in Ruby. It fully supports [JSON HAL](http://stateless.co/hal_specification.html).
+
+## Usage
+
+The examples in this README use the [Splines Demo API](https://github.com/dblock/grape-with-roar) running [here](https://grape-with-roar.herokuapp.com/api).
+
+### API Client
+
+Create an API client.
+
+```ruby
+require 'hyperclient'
+
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api')
+```
+
+By default, Hyperclient adds `application/json` as `Content-Type` and `Accept` headers. It will also send requests as JSON and parse JSON responses. Specify additional headers or authentication if necessary. Hyperclient supports Basic, Token or Digest auth as well as many other [Faraday](http://github.com/lostisland/faraday) extensions.
+
+```ruby
+api = Hyperclient.new('https://grape-with-roar.herokuapp.com/api').tap do |api|
+  api.digest_auth('username', 'password')
+  api.headers.update('Accept-Encoding' => 'deflate, gzip')
+end
+```
+
+### Resources and Attributes
+
+Hyperclient will fetch and discover the resources from your API.
+
+```ruby
+api.splines.each do |spline|
+  puts "A spline with ID #{spline.uuid}."
+end
+```
+
+### Links and Embedded Resources
+
+The splines example above followed a link called "splines". While you can, you do not need to specify the HAL navigational structure, including links or embedded resources. Hyperclient will resolve these for you.  If you prefer, you can explicitly navigate the link structure via `_links`. In the following example the "splines" link leads to a collection of embedded splines. Invoking `api.splines` is equivalent to `api._links.splines._embedded.splines`.
+
+```ruby
+api._links.splines
+```
+
+### Templated Links
+
+Templated links require variables to be expanded. For example, the demo API has a link called "spline" that requires a spline "uuid".
+
+```ruby
+spline = api.spline(uuid: 'uuid')
+puts "Spline #{spline.uuid} is #{spline.reticulated ? 'reticulated' : 'not reticulated'}."
+```
+
+Invoking `api.spline(uuid: 'uuid').reticulated` is equivalent to `api._links.spline._expand(uuid: 'uuid')._resource._attributes.reticulated`.
+
+### Curies
+
+Curies are named tokens that you can define in the document and use to express curie relation URIs in a friendlier, more compact fashion. For example, the demo API contains very long links to images that use an "images" curie. Hyperclient handles curies and resolves these into full links automatically.
+
+```ruby
+puts spline['image:thumbnail'] # => https://grape-with-roar.herokuapp.com/api/splines/uuid/images/thumbnail.jpg
+```
+
+### Attributes
+
+Resource attributes can also be accessed as a hash.
+
+```ruby
+puts spline.to_h # => {"uuid" => "uuid", "reticulated" => true}
+```
+
+The above is equivalent to `spline._attributes.to_h`.
+
+### HTTP
+
+Hyperclient uses [Faraday](http://github.com/lostisland/faraday) under the hood to perform HTTP calls. You can call any valid HTTP method on any resource.
+
+For example, you can examine the API raw JSON by invoking `_get` and examining the `_response.body` hash.
+
+```ruby
+api._get
+api._response.body
+```
+
+Other methods, including `_head` or `_options` are also available.
+
+```ruby
+spline = api.spline(uuid: 'uuid')
+spline._head
+spline._options
+```
+
+Invoke `_post` to create resources.
+
+```ruby
+splines = api.splines
+splines._post(uuid: 'new uuid', reticulated: false)
+```
+
+Invoke `_put` or `_patch` to update resources.
+
+```ruby
+spline = api.spline(uuid: 'uuid')
+spline._put(reticulated: true)
+spline._patch(reticulated: true)
+```
+
+Invoke `_delete` to destroy a resource.
+
+```
+spline = api.spline(uuid: 'uuid')
+spline._delete
+```
+
+### Faraday Connection
+
+You can access the Faraday connection directly to add middleware by calling `connection` on the entry point. As an example, you could use the [faraday-http-cache-middleware](https://github.com/plataformatec/faraday-http-cache).
+
+```ruby
+api.connection.use :http_cache
+```
+
+## Reference
+
+[Hyperclient API Reference](http://rubydoc.org/github/codegram/hyperclient/master/frames).
+
+## Contributing
+
+Hyperclient is work of [many people](https://github.com/codegram/hyperclient/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/codegram/hyperclient/pulls), [propose features and discuss issues](https://github.com/codegram/hyperclient/issues). See [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## License
+
+MIT License, see [LICENSE](LICENSE) for details. Copyright 2012-2014 [Codegram Technologies](http://codegram.com).

data/Rakefile

@@ -14,13 +14,12 @@ if ENV['COVERAGE']
 end
 
 require 'yard'
-YARD::Config.load_plugin('yard-tomdoc') 
+YARD::Config.load_plugin('yard-tomdoc')
 YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/**/*.rb']
   t.options = %w(-r README.md)
 end
 
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -37,4 +36,7 @@ task :spinach do
   ruby '-S spinach'
 end
 
-task default: [:test, :spinach]
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :test, :spinach]