hactor 0.0.1

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 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mike Kelly
+
+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,29 @@
+# Hactor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hactor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hactor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/hactor.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hactor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hactor"
+  gem.version       = Hactor::VERSION
+  gem.authors       = ["Mike Kelly"]
+  gem.email         = ["mikekelly321@gmail.com"]
+  gem.description   = %q{A framework for building hypermedia clients}
+  gem.summary       = %q{A framework for building hypermedia clients}
+  gem.homepage      = "https://github.com/mikekelly/hactor"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'faraday'
+end

data/lib/hactor.rb

@@ -0,0 +1,12 @@
+require 'hactor/version'
+require 'hactor/http/client'
+require 'hactor/actor'
+
+module Hactor
+  def self.start(options)
+    url = options.fetch :url
+    actor = options.fetch :actor
+    http_client = options.fetch(:http_client) { Hactor::HTTP::Client.new }
+    http_client.get(url: url, actor: actor)
+  end
+end

data/lib/hactor/actor.rb

@@ -0,0 +1,7 @@
+module Hactor
+  module Actor
+    def call(response)
+      self.send "on_#{response.status}".to_s, response
+    end
+  end
+end

data/lib/hactor/hal/document.rb

@@ -0,0 +1,22 @@
+require 'delegate'
+require 'json'
+require 'hactor/hal/resource'
+
+module Hactor
+  module HAL
+    class Document < SimpleDelegator
+      attr_reader :body, :resource_class
+
+      def initialize(body, options={})
+        @resource_class = options.fetch(:resource_class) { Resource }
+        @body = JSON.parse(body)
+        super(root_resource)
+      end
+
+      def root_resource
+        @root_resource ||= resource_class.new(body)
+      end
+    end
+  end
+end
+

data/lib/hactor/hal/embedded_collection.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+require 'hactor/hal/flat_collection'
+require 'hactor/hal/resource'
+#require 'hactor/hal/null_resource'
+
+module Hactor
+  module HAL
+    class EmbeddedCollection
+      extend Forwardable
+      include Enumerable
+
+      attr_reader :hash, :embedded_class, :flat_collection_class
+      def_delegators :each
+
+      def initialize(hash, options={})
+        #TODO: throw/log parsing error if not hash
+        @embedded_class = options.fetch(:embedded_class) { Resource }
+        @flat_collection_class = options.fetch(:flat_collection_class) { FlatCollection }
+        @hash = hash
+      end
+
+      def all
+        @all ||= flat_collection_class.new(hash, item_class: embedded_class)
+      end
+
+      def find_by_rel(rel)
+        all.find(->{ NullResource.new }) { |resource| resource.rel == rel }
+      end
+    end
+  end
+end

data/lib/hactor/hal/flat_collection.rb

@@ -0,0 +1,25 @@
+module Hactor
+  module HAL
+    class FlatCollection < Array
+      attr_reader :item_class
+
+      def initialize(hash, options={})
+        @item_class = options.fetch(:item_class)
+        super flatten(hash)
+      end
+
+      private
+      def flatten(hash)
+        arr = []
+          hash.each do |rel, value|
+            if value.is_a? Array
+              arr += value.map { |link| item_class.new(link.merge(rel: rel)) }
+            else
+              arr.push item_class.new(value.merge(rel: rel))
+            end
+          end
+        arr
+      end
+    end
+  end
+end

data/lib/hactor/hal/link.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+
+module Hactor
+  module HAL
+    class Link < OpenStruct;end
+  end
+end

data/lib/hactor/hal/link_collection.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+require 'hactor/hal/flat_collection'
+require 'hactor/hal/link'
+#require 'hactor/hal/null_link'
+
+module Hactor
+  module HAL
+    class LinkCollection
+      extend Forwardable
+      include Enumerable
+
+      attr_reader :hash, :link_class, :flat_collection_class
+      def_delegators :all, :each
+
+      def initialize(hash, options={})
+        #TODO: throw/log parsing error if not hash
+        @link_class = options.fetch(:link_class) { Link }
+        @flat_collection_class = options.fetch(:flat_collection_class) { FlatCollection }
+        @hash = hash
+      end
+
+      def all
+        @all ||= flat_collection_class.new(hash, item_class: link_class)
+      end
+
+      def find_by_rel(rel)
+        all.find(->{ NullLink.new }) { |link| link.rel == rel }
+      end
+    end
+  end
+end

data/lib/hactor/hal/resource.rb

@@ -0,0 +1,40 @@
+require 'hactor/hal/link_collection'
+require 'hactor/hal/embedded_collection'
+
+module Hactor
+  module HAL
+    class Resource
+      RESERVED_PROPERTIES = ['_links', '_embedded']
+
+      attr_reader :state, :link_collection_class, :embedded_collection_class
+
+      def initialize(state, options={})
+        @link_collection_class = options.fetch(:link_collection_class) { LinkCollection }
+        @embedded_collection_class = options.fetch(:embedded_collection_class) { EmbeddedCollection }
+        @state = state
+      end
+
+      def properties
+        @properties ||= state.reject { |k,v|
+          RESERVED_PROPERTIES.include? k
+        }
+      end
+
+      def link(rel, options={})
+        links.find_by_rel(rel)
+      end
+
+      def links
+        @links ||= link_collection_class.new(state['_links'])
+      end
+
+      def embedded_resource(rel)
+        embedded_resources.find(rel)
+      end
+
+      def embedded_resources
+        @embedded_resources ||= embedded_collection_class.new(state['_embedded'])
+      end
+    end
+  end
+end

data/lib/hactor/http/client.rb

@@ -0,0 +1,33 @@
+require 'hactor/http/response'
+require 'faraday'
+
+module Hactor
+  module HTTP
+    class Client < SimpleDelegator
+      attr_reader :response_class, :backend
+
+      def initialize(options={})
+        @response_class = options.fetch(:response_class) { Hactor::HTTP::Response }
+        @backend = options.fetch(:backend) { Faraday.new }
+        super(@backend)
+      end
+
+      def follow(link, options = {})
+        actor = options.fetch(:actor)
+        context_url = options.fetch(:context_url)
+
+        url = context_url.merge(link.href)
+        get(url: url, actor: actor)
+      end
+
+      def get(options)
+        url = options.fetch :url
+        actor = options.fetch :actor
+
+        response = response_class.new(backend.get(url),
+                                      http_client: self)
+        actor.call response
+      end
+    end
+  end
+end

data/lib/hactor/http/response.rb

@@ -0,0 +1,29 @@
+require 'delegate'
+require 'hactor/hal/document'
+
+module Hactor
+  module HTTP
+    class Response < SimpleDelegator
+      attr_reader :request_client, :codec
+
+      def initialize(response, options={})
+        @request_client = options.fetch(:http_client)
+        @codec = options.fetch(:codec) { Hactor::HAL::Document }
+        @body = options[:body]
+        super(response)
+      end
+
+      def follow(rel, options={})
+        actor = options.fetch(:actor) { Hactor::NullActor.new }
+        client = options.fetch(:http_client) { request_client }
+
+        link = body.link(rel)
+        client.follow(link, context_url: env[:url], actor: actor)
+      end
+
+      def body
+        @body ||= codec.new(__getobj__.body)
+      end
+    end
+  end
+end

data/lib/hactor/version.rb

@@ -0,0 +1,3 @@
+module Hactor
+  VERSION = "0.0.1"
+end

data/spec/hactor/hal/document_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'hactor/hal/document'
+
+describe Hactor::HAL::Document do
+  describe "#root_resource" do
+    let(:resource_class) { mock }
+    let(:sentinel) { stub }
+    let(:body) { '{}' }
+    let(:doc) do
+      Hactor::HAL::Document.new(body,
+                                resource_class: resource_class)
+    end
+
+    it "returns new Resource object" do
+      resource_class.should_receive(:new)
+        .with(JSON.parse(body))
+        .and_return(sentinel)
+
+      doc.root_resource.should == sentinel
+    end
+  end
+end

data/spec/hactor/hal/embedded_collection_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'hactor/hal/embedded_collection'
+
+#TODO: implement these specs
+describe "specs should be here. sue me." do
+end

data/spec/hactor/hal/flat_collection_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+require 'hactor/hal/flat_collection'
+
+#TODO: implement these specs
+describe "specs should be here. sue me." do
+end

data/spec/hactor/hal/link_collection_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'hactor/hal/link_collection'
+
+describe Hactor::HAL::LinkCollection do
+  let(:simple_link_hash) do
+    {
+      'self' => { 'href' => '/' }
+    }
+  end
+  let(:link_class) { mock }
+  let(:flat_collection_class) { mock }
+  let(:flat_collection) { mock }
+  let(:link) { stub }
+  let(:collection) do
+    Hactor::HAL::LinkCollection.new(simple_link_hash,
+                                    link_class: link_class,
+                                    flat_collection_class: flat_collection_class)
+  end
+
+  describe "#find" do
+    it "finds a link with the supplied rel" do
+      flat_collection_class.should_receive(:new)
+        .with(simple_link_hash, item_class: link_class)
+        .and_return(flat_collection)
+      flat_collection.should_receive(:find).and_return(link)
+
+      collection.find_by_rel(:self).should == link
+    end
+  end
+end

data/spec/hactor/hal/resource_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'hactor/hal/resource'
+
+describe Hactor::HAL::Resource do
+  let(:json) do
+    {
+      '_links' => {
+        'self' => { 'href' => '/' }
+      },
+      '_embedded' => {
+        'widget' => { 'bla' => 'x' }
+      },
+      'foo' => 'bar',
+      'baz' => 123
+    }
+  end
+
+  let(:resource) do
+    Hactor::HAL::Resource.new(json,
+                              link_collection_class: link_collection_class,
+                              embedded_collection_class: embedded_collection_class)
+  end
+
+  let(:link_collection_class) { mock }
+  let(:embedded_collection_class) { mock }
+  let(:link_collection) { mock }
+  let(:embedded_collection) { mock }
+  let(:rel) { stub }
+
+  describe "#properties" do
+    it "returns a Hash containing the json with the reserved properties removed" do
+      resource.properties.should == { 'foo' => 'bar', 'baz' => 123 }
+    end
+  end
+
+  context "links" do
+    before :each do
+      link_collection_class.should_receive(:new).with(json['_links']).and_return(link_collection)
+    end
+
+    describe "#link" do
+      it "finds a link with the given rel" do
+        link = stub
+        link_collection.should_receive(:find_by_rel).with(rel).and_return(link)
+        resource.link(rel).should == link
+      end
+    end
+
+    describe "#links" do
+      it "returns a new link set" do
+        resource.links.should == link_collection
+      end
+    end
+  end
+
+  context "embedded resources" do
+    before :each do
+      embedded_collection_class.should_receive(:new).with(json['_embedded']).and_return(embedded_collection)
+    end
+
+    describe "#embedded_resource" do
+      it "finds an embedded resource with the given rel" do
+        embedded_resource = stub
+        embedded_collection.should_receive(:find).with(rel).and_return(embedded_resource)
+        resource.embedded_resource(rel).should == embedded_resource
+      end
+    end
+
+    describe "#embedded_resources" do
+      it "returns a new embedded set" do
+        resource.embedded_resources.should == embedded_collection
+      end
+    end
+  end
+end

data/spec/hactor/http/client_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'hactor/http/client'
+
+describe Hactor::HTTP::Client do
+  let(:response_class) { mock }
+  let(:backend) { mock }
+  let(:actor) { mock }
+  let(:client) do
+    Hactor::HTTP::Client.new(response_class: response_class,
+                             backend: backend)
+  end
+
+  describe "#get" do
+    context "a valid URL is supplied" do
+      let(:url) { 'http://example.com/' }
+      let(:response) { stub }
+      let(:hactor_response) { stub }
+
+      it "GETs from URL and passes Response object to the actor" do
+        backend.should_receive(:get)
+          .with(url)
+          .and_return(response)
+        response_class.should_receive(:new)
+          .with(response, http_client: client)
+          .and_return(hactor_response)
+        actor.should_receive(:call)
+          .with(hactor_response)
+
+        client.get(url: url, actor: actor)
+      end
+    end
+
+    describe "#follow" do
+      let(:link) { mock }
+      let(:uri) { stub }
+      let(:context_url) { mock }
+      let(:resolved_uri) { stub }
+
+      it "should use the context url to resolve link href" do
+        Delegator.class_eval { include RSpec::Mocks::Methods }
+        client.stub!(:get).with(url: resolved_uri, actor: actor)
+        link.should_receive(:href)
+          .and_return(uri)
+        context_url.should_receive(:merge)
+          .with(uri)
+          .and_return(resolved_uri)
+
+        client.follow(link, context_url: context_url, actor: actor)
+      end
+    end
+  end
+end

data/spec/hactor/http/response_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'hactor/http/response'
+
+describe Hactor::HTTP::Response do
+  let(:codec) { mock }
+  let(:body) { mock }
+  let(:wrapped_response) { mock }
+  let(:http_client) { mock }
+
+  describe "#follow" do
+    let(:rel) { stub }
+    let(:link) { stub }
+    let(:actor) { stub }
+    let(:context_url) { stub }
+    let(:response) do
+      Hactor::HTTP::Response.new(wrapped_response,
+                                 http_client: http_client,
+                                 codec: codec,
+                                 body: body)
+    end
+
+    it "follows the link with supplied rel" do
+      body.should_receive(:link).with(rel).and_return(link)
+      http_client.should_receive(:follow)
+        .with(link, context_url: context_url, actor: actor)
+      wrapped_response.should_receive(:env)
+        .and_return({ url: context_url })
+
+      response.follow(rel, actor: actor, http_client: http_client)
+    end
+  end
+
+  describe "#body" do
+    let(:body) { mock }
+    let(:sentinel) { stub }
+    let(:response) do
+      Hactor::HTTP::Response.new(wrapped_response,
+                                 http_client: http_client,
+                                 codec: codec)
+    end
+
+    it "passes itself into the codec" do
+      wrapped_response.should_receive(:body).and_return(body)
+      codec.should_receive(:new).with(body).and_return(sentinel)
+
+      response.body.should == sentinel
+    end
+  end
+end

data/spec/hactor_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'hactor'
+
+describe Hactor do
+  describe ".start" do
+    context "a valid url is supplied" do
+      let(:url) { 'http://example.com/' }
+      let(:actor) { mock }
+      let(:http_client) { mock }
+      it "GETs from the URL and passes a response object to an actor" do
+        http_client.should_receive(:get).with(url: url, actor: actor)
+        Hactor.start(url: url, actor: actor, http_client: http_client)
+      end
+    end
+  end
+end

data/spec/integration.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'hactor'
+require 'hactor/actor'
+
+class UserListActor
+  include Hactor::Actor
+
+  def on_200(response)
+    user_links = response.body.links.select { |link| link.rel == 'ht:user' }
+    user_links.each do |link|
+      puts "#{link.title} (#{link.href})"
+    end
+  end
+end
+
+class LatestPostActor
+  include Hactor::Actor
+
+  def on_200(response)
+    puts response.body.embedded_resources.all.first.links.all
+  end
+end
+
+class HomeActor
+  include Hactor::Actor
+
+  def on_200(response)
+    response.follow 'ht:users', actor: UserListActor.new
+    response.follow 'ht:latest-posts', actor: LatestPostActor.new
+  end
+end
+
+describe Hactor do
+  it "should work as expected :)" do
+    Hactor.start url: 'http://haltalk.herokuapp.com/', actor: HomeActor.new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+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
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: hactor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mike Kelly
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A framework for building hypermedia clients
+email:
+- mikekelly321@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hactor.gemspec
+- lib/hactor.rb
+- lib/hactor/actor.rb
+- lib/hactor/hal/document.rb
+- lib/hactor/hal/embedded_collection.rb
+- lib/hactor/hal/flat_collection.rb
+- lib/hactor/hal/link.rb
+- lib/hactor/hal/link_collection.rb
+- lib/hactor/hal/resource.rb
+- lib/hactor/http/client.rb
+- lib/hactor/http/response.rb
+- lib/hactor/version.rb
+- spec/hactor/hal/document_spec.rb
+- spec/hactor/hal/embedded_collection_spec.rb
+- spec/hactor/hal/flat_collection_spec.rb
+- spec/hactor/hal/link_collection_spec.rb
+- spec/hactor/hal/resource_spec.rb
+- spec/hactor/http/client_spec.rb
+- spec/hactor/http/response_spec.rb
+- spec/hactor_spec.rb
+- spec/integration.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mikekelly/hactor
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A framework for building hypermedia clients
+test_files:
+- spec/hactor/hal/document_spec.rb
+- spec/hactor/hal/embedded_collection_spec.rb
+- spec/hactor/hal/flat_collection_spec.rb
+- spec/hactor/hal/link_collection_spec.rb
+- spec/hactor/hal/resource_spec.rb
+- spec/hactor/http/client_spec.rb
+- spec/hactor/http/response_spec.rb
+- spec/hactor_spec.rb
+- spec/integration.rb
+- spec/spec_helper.rb