restroom 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfe0db3505141774d2a5408400265d2583936d22
+  data.tar.gz: 32d998f6b20581d5ba0a1a931a48dd71371ac82c
+SHA512:
+  metadata.gz: 79168d50ff9ce7570b8c087423061d3fb2b258ead81baa3dd3949b3fe4f76e818fc61795720b48b6c8ecd94947d5bed375c026726ab477fdb6541de453f8aa59
+  data.tar.gz: 494cf28b04183c8c01bd8ba7f693bd7ad6ee85e6e0c5ec4834ef07ac3088c9da142f82bb9ae6cbd2580ac3dbfaa71a1045b8db0dffda824df17a60d23f7d0988

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+restroom

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Fairfax Media
+
+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,76 @@
+# Restroom
+
+Restroom provides a DSL to quickly and easily describe a RESTful and build a gem around it. It was extracted during the development of a Bitbucket API gem, thus the examples below.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restroom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install restroom
+
+## Usage
+
+Here's the client code from the [Bitbucket2](http://github.com/fairfax/bitbucket2) gem:
+
+```
+module Bitbucket2
+  class Client
+    include Restroom
+
+    restroom 'https://api.bitbucket.org', base_path: '2.0' do
+      exposes :repositories, class: Repository, id: :full_name do
+        exposes :commits, class: Commit, id: :hash
+        exposes :pull_requests, resource: 'pullrequests', class: PullRequest do
+          exposes :commits, class: Commit, id: :hash
+        end
+      end
+    end
+  end
+end
+```
+
+...and that's it - apart from some simple model files (for which I like to use Virtus):
+
+```
+module Bitbucket2
+  class Commit
+    include Virtus.model
+
+    attribute :hash, String
+  end
+end
+```
+
+...which are instantiated with a hash of attributes extracted from the API's returned JSON.
+
+The `exposes` invocation takes several options:
+
+ - a key which is used to build the relation methods (so we can call Bitbucket2::Client.new.repositories, in this case),
+ - a class to instantiate,
+ - a id for building nested paths (so in the case of repositories we use the `full_name` attribute).
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at http://github.com/fairfaxmedia/restroom.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "restroom"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/restroom.rb

@@ -0,0 +1,66 @@
+require "restroom/version"
+require 'restroom/proxy'
+require 'restroom/relation'
+require 'restroom/context'
+
+require 'active_support/inflector'
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+
+
+module Restroom
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def restroom_parent
+    self.class
+  end
+
+  def id
+    nil
+  end
+
+  module ClassMethods
+    attr_reader :endpoint, :base_path
+
+    def restroom(endpoint, base_path: nil, &block)
+      @endpoint = endpoint
+      @base_path = base_path
+      Context.new(host: self, parent: self, &block)
+    end
+
+    def resource_path
+      base_path
+    end
+
+    def model
+      self
+    end
+
+    def response_filter
+      default_response_filter
+    end
+
+    def default_response_filter
+      Proc.new { |mode, response| response }
+    end
+
+    def stack
+    end
+
+    def connection
+      @connection ||= Faraday.new endpoint do |config|
+        stack(config)
+        config.adapter Faraday.default_adapter
+      end
+    end
+  end
+
+  class Error < StandardError; end
+  class ApiError < Error; end
+  class DataError < Error; end
+  class NetworkError < Error; end
+  class AuthenticationError < Error; end
+end

data/lib/restroom/context.rb

@@ -0,0 +1,61 @@
+require 'restroom/relation'
+
+module Restroom
+  class Context
+
+    STRUCTURE  = %I<children host parent key>
+    ATTRIBUTES = %I<resource model id response_filter>
+    INHERITABLE = %I<response_filter>
+
+    attr_reader   *STRUCTURE
+    attr_accessor *ATTRIBUTES
+
+
+    INHERITABLE.each do |attr|
+      define_method attr do |value=nil|
+        return instance_variable_set("@#{attr}", value) if value
+        instance_variable_get("@#{attr}") || @parent.send(attr)
+      end
+    end
+
+    def initialize(host: nil, parent:, key: nil, **args, &block)
+      @children = []
+      @id = :id
+
+      args.each { |k, v| send "#{k}=", v }
+      instance_eval &block if block_given?
+
+      @key = key
+      @resource ||= key
+      @model ||= classify_resource(@resource)
+      @host = host || model # TODO guess model from key
+      @parent = parent
+
+      @model.send(:attr_accessor, :restroom_parent) if @model
+
+      @host.include Relation
+      @children.each do |child|
+        @host.add_relation(child.key, child)
+      end
+    end
+
+    def classify_resource(resource)
+      resource.to_s.classify.constantize if resource
+    end
+
+    def exposes key, **args, &block
+      @children << child = self.class.new(key: key, parent: self, **args, &block)
+    end
+
+    def dump
+      dumper(self, 0)
+    end
+
+    def dumper context, depth
+      puts "#{'  ' * depth}#{context} - host: #{context.host}, parent: #{context.parent}, class: #{context.model}, id: #{context.id}"#, filter: #{context.response_filter}"
+      context.children.each do |child|
+        dumper(child, depth+1)
+      end
+    end
+  end
+end

data/lib/restroom/proxy.rb

@@ -0,0 +1,114 @@
+require 'restroom/relation'
+
+module Restroom
+  class Proxy
+    include Relation
+    attr_reader :instance, :dsl
+
+    def initialize(instance, dsl)
+      @instance = instance
+      @dsl = dsl
+    end
+
+    def iterate filter_by: nil, **args
+      Enumerator.new do |yielder|
+        page = 1
+        loop do
+          if filter_by
+            list = filter(filter_by, **args.merge(page: page))
+          else
+            list = all(**args.merge(page: page))
+          end
+          page += 1
+          break if list.empty?
+          list.each { |c| yielder.yield c }
+        end
+      end
+    end
+
+    def response_filter
+      dsl.response_filter
+    end
+
+    def resource
+      dsl.resource
+    end
+
+    def model
+      dsl.model
+    end
+
+    def id_method
+      dsl.id
+    end
+
+    def parent
+      instance.restroom_parent
+    end
+
+    def connection
+      parent.connection
+    end
+
+    def build data={}
+      model.new(data).tap do |obj|
+        obj.restroom_parent = self
+      end
+    end
+
+    def instance_id
+      instance.send(dsl.parent.id)
+    end
+
+    def expand_path *path
+      path.compact.join('/')
+    end
+
+    def resource_path
+      expand_path(parent.resource_path, instance_id, resource)
+    end
+
+    def singular_path(key)
+      expand_path(resource_path, key)
+    end
+
+    def plural_path
+      resource_path
+    end
+
+    def parsed_response body
+      JSON.parse body
+    rescue JSON::ParseError
+      raise ApiError, "couldn't parse response: #{body[0..20]}"
+    end
+
+    def filter_result(path, mode, params={})
+      response_filter.call(mode, parsed_response(request(:get, path, params)))
+    end
+
+    def get key
+      build filter_result(singular_path(key), :singular)
+    end
+
+    def filter filter, params={}
+      filter_result(expand_path(resource_path, filter), :plural, params).map { |data| build data }
+    end
+
+    def all params={}
+      filter_result(plural_path, :plural, params).map { |data| build data }
+    end
+
+    def request method, path, args={}
+      response = connection.send(method, path, args)
+      if (200...300).include? response.status
+        return response.body
+      else
+        raise AuthenticationError, 'unauthorised' if response.status == 401
+        raise AuthenticationError, 'forbidden' if response.status == 403
+        raise ApiError, response.body[0..100]
+      end
+    rescue Faraday::ClientError => e
+      raise NetworkError, e.message
+    end
+  end
+end

data/lib/restroom/relation.rb

@@ -0,0 +1,16 @@
+module Restroom
+  module Relation
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def add_relation key, dsl
+        # TODO Check for collision
+        define_method key do
+          Proxy.new self, dsl
+        end
+      end
+    end
+  end
+end

data/lib/restroom/version.rb

@@ -0,0 +1,3 @@
+module Restroom
+  VERSION = "0.2.0"
+end

data/restroom.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'restroom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "restroom"
+  spec.version       = Restroom::VERSION
+  spec.authors       = ["Simon Hildebrandt"]
+  spec.email         = ["simon.hildebrandt@fairfaxmedia.com.au"]
+
+  spec.summary       = %q{RESTful api gem scaffolding}
+  spec.description   = %q{Restroom provides an expressive DSL for quickly implementing wrapper gems for REST APIs.}
+  spec.homepage      = "http://github.com/fairfaxmedia/restroom"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency 'faraday'
+  spec.add_runtime_dependency 'activesupport'
+  spec.add_runtime_dependency 'json'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'faraday_middleware'
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: restroom
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Simon Hildebrandt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: activesupport
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 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: byebug
+  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: faraday_middleware
+  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: Restroom provides an expressive DSL for quickly implementing wrapper
+  gems for REST APIs.
+email:
+- simon.hildebrandt@fairfaxmedia.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/restroom.rb
+- lib/restroom/context.rb
+- lib/restroom/proxy.rb
+- lib/restroom/relation.rb
+- lib/restroom/version.rb
+- restroom.gemspec
+homepage: http://github.com/fairfaxmedia/restroom
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: RESTful api gem scaffolding
+test_files: []