cetacean 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e46de21051edb9c941f19ed926b5a124396a3b0
+  data.tar.gz: 60a0c1b28bea7eb5ffcd9e42bf9aa8bfff4fe41b
+SHA512:
+  metadata.gz: 6e8313db79a64e6ff05d0d97ada62b92ebe745de37827344b57207b38d0e8cda0c74358d9980e0abe6f3308e5ff7fbd26aa09aa02eb256612eaf41197f9fc3f7
+  data.tar.gz: e7e39696b01a9d848a330ddc5d20bf8763001377580843bc689d7b2fa471c86a244f9bdb6be37fe79f9f55e6ea8af16a14357f712aac6f8ac1c50f0ceaaeef3a

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CHANGES.md

@@ -0,0 +1,5 @@
+# Changes
+
+## 1.0.0
+
+* The first glimmers of functionality. - Ben Hamill

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cetacean.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ben Hamill
+
+MIT License
+
+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,52 @@
+> Everything the system does *for* you, it also does *to* you.
+
+# Cetacean [![Build Status](https://travis-ci.org/benhamill/cetacean.png)](https://travis-ci.org/benhamill/cetacean) [![Code Climate](https://codeclimate.com/github/benhamill/cetacean.png)](https://codeclimate.com/github/benhamill/cetacean)
+
+The [HAL](http://stateless.co/hal_specification.html) client that does almost
+nothing for/to you.
+
+Cetacean is tightly coupled to [Faraday](http://rubygems.org/gems/faraday), but
+doesn't actually call it. You set up your own Faraday client and use it to make
+requests. You feed Cetacean `Faraday::Request` objects and it helps you figure
+out if they're HAL documents and pull useful data out of them if they are.
+
+
+## Usage
+
+Something like this:
+
+```ruby
+api = Faraday.new('https://api.example.com/') do |faraday|
+  faraday.headers['Accept'] = 'application/hal+json'
+end
+
+root = Cetacean.new(api.get)
+users = Cetacean.new(api.get(root.get_uri(:users).to_s))
+user = users.embedded(:users).first
+
+important_blog_post = Cetacean.new(api.get(user.get_uri(:post).expand(id: 2)))
+
+interesting_blog_posts = Cetacean.new(api.get(root.get_uri(:search_posts).expand(q: 'interesting')))
+```
+
+Check out the specs for more detailed uses.
+
+
+## Contributing
+
+Help is gladly welcomed. If you have a feature you'd like to add, it's much more
+likely to get in (or get in faster) the closer you stick to these steps:
+
+1. Open an Issue to talk about it. We can discuss whether it's the right
+  direction or maybe help track down a bug, etc.
+1. Fork the project, and make a branch to work on your feature/fix. Master is
+  where you'll want to start from.
+1. Turn the Issue into a Pull Request. There are several ways to do this, but
+  [hub](https://github.com/defunkt/hub) is probably the easiest.
+1. Make sure your Pull Request includes tests.
+1. Bonus points if your Pull Request updates `CHANGES.md` to include a summary
+   of your changes and your name like the other entries. If the last entry is
+   the last release, add a new `## Unreleased` heading at the top.
+
+If you don't know how to fix something, even just a Pull Request that includes a
+failing test can be helpful. If in doubt, make an Issue to discuss.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/cetacean.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cetacean/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cetacean"
+  spec.version       = Cetacean::VERSION
+  spec.authors       = ["Ben Hamill"]
+  spec.email         = ["git-commits@benhamill.com"]
+  spec.description   = %q{The HAL client that does almost nothing for/to you.}
+  spec.summary       = %q{The HAL client that does almost nothing for/to you.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 0.8"
+  spec.add_dependency "uri_template", "~> 0.6"
+  spec.add_dependency "activesupport", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sinatra"
+end

data/lib/cetacean.rb

@@ -0,0 +1,11 @@
+require_relative 'cetacean/version'
+require_relative 'cetacean/resource'
+require_relative 'cetacean/embedded_resource'
+require_relative 'cetacean/embedded_resource_collection'
+require_relative 'cetacean/response'
+
+module Cetacean
+  def self.new(response)
+    Cetacean::Response.new(response)
+  end
+end

data/lib/cetacean/embedded_resource.rb

@@ -0,0 +1,11 @@
+class Cetacean::EmbeddedResource
+  include Cetacean::Resource
+
+  def initialize(document)
+    @hal = document
+  end
+
+  private
+
+  attr_reader :hal
+end

data/lib/cetacean/embedded_resource_collection.rb

@@ -0,0 +1,17 @@
+class Cetacean::EmbeddedResourceCollection
+  include Enumerable
+
+  def initialize(document_array)
+    @document_array = document_array
+  end
+
+  def each
+    document_array.each do |document|
+      yield Cetacean::EmbeddedResource.new(document)
+    end
+  end
+
+  private
+
+  attr_reader :document_array
+end

data/lib/cetacean/resource.rb

@@ -0,0 +1,38 @@
+require 'uri_template'
+require 'forwardable'
+require 'active_support'
+
+module Cetacean::Resource
+  extend Forwardable
+
+  def_delegators :hal, :[], :fetch
+
+  def attributes
+    hal.except('_links', '_embedded')
+  end
+
+  def embedded(rel=nil)
+    return hal['_embedded'] if rel.nil?
+
+    rel = rel.to_s
+
+    if (document = embedded[rel])
+      case document
+      when Array
+        Cetacean::EmbeddedResourceCollection.new(document)
+      else
+        Cetacean::EmbeddedResource.new(document)
+      end
+    end
+  end
+
+  def get_uri(rel)
+    return unless links.include?(rel.to_s)
+
+    URITemplate.new(links[rel.to_s]['href'])
+  end
+
+  def links
+    hal['_links'] || {}
+  end
+end

data/lib/cetacean/response.rb

@@ -0,0 +1,33 @@
+require 'forwardable'
+
+class Cetacean::Response
+  include Cetacean::Resource
+  extend Forwardable
+
+  def_delegators :response, :status, :success?, :body
+
+  attr_reader :response
+
+  # Feed me Faraday::Response objects or things that quack like them.
+  def initialize(response)
+    @response = response
+  end
+
+  # Tells you whether the response thinks it's a HAL document or not. Does no
+  # validation.
+  def hal?
+    response.headers['content-type'] =~ %r{\Aapplication/hal\+json}
+  end
+
+  private
+
+  def hal
+    @hal ||= parse_hal
+  end
+
+  def parse_hal
+    hal? ? JSON.parse(response.body) : {}
+  rescue JSON::JSONError, TypeError
+    {}
+  end
+end

data/lib/cetacean/version.rb

@@ -0,0 +1,7 @@
+module Cetacean
+  VERSION = "1.0.0"
+
+  def self.version
+    VERSION
+  end
+end

data/spec/acceptance/cetacean_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+require 'json'
+
+describe Cetacean do
+  let(:api) do
+    Faraday.new('http://api.example.com') do |f|
+      f.headers['Accept'] = 'application/hal+json'
+      f.adapter Faraday.default_adapter
+    end
+  end
+
+  context "when fed a valid HAL response" do
+    before do
+      stub_service 'http://api.example.com', Sinatra.new do
+        get '/' do
+          content_type 'application/hal+json'
+          JSON.dump(
+            {
+              _links: {
+                self: { href: '/' },
+              },
+              api_ranking: 'the best',
+              _embedded: {
+                singular: {
+                  _links: { self: { href: '/singular' } }
+                },
+                plural: [
+                  { _links: { self: { href: '/plural/1' } } },
+                  { _links: { self: { href: '/plural/2' } } },
+                ]
+              }
+            }
+          )
+        end
+      end
+    end
+
+    subject { Cetacean.new(api.get) }
+
+    it "knows it's HAL" do
+      expect(subject).to be_hal
+    end
+
+    it "can find links by rel" do
+      expect(subject.get_uri(:self)).to eq('/')
+    end
+
+    it "hands out the links hash" do
+      expect(subject.links).to eq('self' => { 'href' => '/' })
+    end
+
+    it "returns URITemplates when asked for a uri" do
+      expect(subject.get_uri(:self)).to be_a(URITemplate)
+    end
+
+    it "allows access to attributes with []" do
+      expect(subject['api_ranking']).to eq('the best')
+    end
+
+    it "allows access to attributes with fetch" do
+      expect(subject.fetch('api_ranking')).to eq('the best')
+    end
+
+    it "does defaulting on attribute fetches" do
+      expect(subject.fetch('not an attribute', 'default')).to eq('default')
+    end
+
+    it "hands out a hash of attributes" do
+      expect(subject.attributes).to eq('api_ranking' => 'the best')
+    end
+
+    it "lists embeds" do
+      expect(subject.embedded).to include('singular')
+      expect(subject.embedded).to include('plural')
+    end
+
+    it "handles singular embeds" do
+      expect(subject.embedded(:singular).get_uri(:self)).to eq('/singular')
+    end
+
+    it "handles plural embeds" do
+      subject.embedded(:plural).each_with_index do |plur, index|
+        expect(plur.get_uri(:self)).to eq("/plural/#{index + 1}")
+      end
+    end
+  end
+
+  context "when fed invalid HAL" do
+    before do
+      stub_service 'http://api.example.com', Sinatra.new do
+        get '/' do
+          content_type 'application/hal+json'
+          "<html></html>"
+        end
+      end
+    end
+
+    subject { Cetacean.new(api.get) }
+
+    it "thinks it's HAL" do
+      expect(subject).to be_hal
+    end
+
+    it "can't find links by rel" do
+      expect(subject.get_uri(:self)).to be_nil
+    end
+  end
+
+  context "when fed non-HAL" do
+    before do
+      stub_service 'http://api.example.com', Sinatra.new do
+        get '/' do
+          "<html></html>"
+        end
+      end
+    end
+
+    subject { Cetacean.new(api.get) }
+
+    it "knows it isn't HAL" do
+      expect(subject).to_not be_hal
+    end
+
+    it "can't find links by rel" do
+      expect(subject.get_uri(:self)).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'cetacean'
+
+require 'webmock/rspec'
+require 'pry'
+require 'sinatra/base'
+require 'faraday'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end
+
+WebMock.disable_net_connect!
+
+def stub_service(uri, stub, &block)
+  uri = URI.parse(uri)
+  port = uri.port != uri.default_port ? ":#{uri.port}" : ""
+  stub = block ? Sinatra.new(stub, &block) : stub
+
+  WebMock.stub_request(
+    :any,
+    %r{^#{uri.scheme}://(.*:.*@)?#{uri.host}#{port}/.*$}
+  ).to_rack(stub)
+end

data/spec/unit/cetacean_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Cetacean do
+  describe ".version" do
+    it "is available as a constant" do
+      expect(Cetacean::VERSION).to_not be_nil
+    end
+
+    it "is available as a method" do
+      expect(Cetacean.version).to_not be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: cetacean
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ben Hamill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: uri_template
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: webmock
+  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: pry
+  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: sinatra
+  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: The HAL client that does almost nothing for/to you.
+email:
+- git-commits@benhamill.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGES.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cetacean.gemspec
+- lib/cetacean.rb
+- lib/cetacean/embedded_resource.rb
+- lib/cetacean/embedded_resource_collection.rb
+- lib/cetacean/resource.rb
+- lib/cetacean/response.rb
+- lib/cetacean/version.rb
+- spec/acceptance/cetacean_spec.rb
+- spec/spec_helper.rb
+- spec/unit/cetacean_spec.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: The HAL client that does almost nothing for/to you.
+test_files:
+- spec/acceptance/cetacean_spec.rb
+- spec/spec_helper.rb
+- spec/unit/cetacean_spec.rb