hal_api-rails 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cea939b833fbbe9155587026dfc9fc5f6bcadf8a
+  data.tar.gz: a8587cf6a4d13da538874e8fa1f795be9d2c99df
+SHA512:
+  metadata.gz: 25ac0d46c54b7a09e012580dead423d3a336894fe8af44d16b95a534e99f53363ed3230c8243c651713fbf8b551895780f45818f3b438934a1906827b07aa700
+  data.tar.gz: f074268d356d73b338d8fe1d8a98c139c6b85a545e5ec32f41baf788f633d0851808f732c16fab960eb4245d026272097f74276bd2d94e252f3a96dcf25f006e

data/.gitignore

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other 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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Rhoden
+
+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,41 @@
+# HalApi::Rails
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hal_api/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hal_api-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hal_api-rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 https://github.com/[USERNAME]/hal_api-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hal_api/rails"
+
+# 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/hal_api-rails.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hal_api/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hal_api-rails"
+  spec.version       = HalApi::Rails::VERSION
+  spec.authors       = ["Chris Rhoden", "Andrew Kuklewicz"]
+  spec.email         = ["carhoden@gmail.com", "andrew@beginsinwonder.com"]
+
+  spec.summary       = %q{JSON HAL APIs on Rails in the style of PRX}
+  spec.description   = %q{JSON HAL APIs on Rails in the style of PRX v4. Uses ROAR}
+  spec.homepage      = "https://www.github.com/PRX/"
+  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_dependency "activemodel", ">= 3.0.0"
+  spec.add_dependency "actionpack", ">= 3.0.0"
+  spec.add_dependency "rack-test", "~> 0.6.2"
+  spec.add_dependency "activesupport", ">= 3.0.0"
+  spec.add_dependency "responders", "~> 2.0"
+  spec.add_dependency "roar-rails", "~> 1.0.1"
+  spec.add_dependency "multi_json"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/hal_api.rb

@@ -0,0 +1,7 @@
+module HalApi
+  require 'hal_api/paged_collection'
+  require 'hal_api/errors'
+  require 'hal_api/controller'
+  # require 'hal_api/representer'
+  require 'hal_api/represented_model'
+end

data/lib/hal_api/controller.rb

@@ -0,0 +1,39 @@
+require 'active_support/concern'
+require 'responders'
+require 'roar-rails'
+
+module HalApi::Controller
+  extend ActiveSupport::Concern
+
+  require 'hal_api/controller/actions'
+  require 'hal_api/controller/cache'
+  require 'hal_api/controller/resources'
+  require 'hal_api/controller/exceptions'
+
+  include HalApi::Controller::Actions
+  include HalApi::Controller::Cache
+  include HalApi::Controller::Resources
+  include HalApi::Controller::Exceptions
+
+  included do
+    include Roar::Rails::ControllerAdditions
+
+    before_action :set_accepts
+    respond_to :hal, :json
+
+    hal_rescue_standard_errors
+  end
+
+  module ClassMethods
+    include HalApi::Controller::Actions::ClassMethods
+    include HalApi::Controller::Cache::ClassMethods
+    include HalApi::Controller::Resources::ClassMethods
+    include HalApi::Controller::Exceptions::ClassMethods
+  end
+
+  private
+
+  def set_accepts
+    request.format = :json if request.format == Mime::HTML
+  end
+end

data/lib/hal_api/controller/actions.rb

@@ -0,0 +1,116 @@
+module HalApi::Controller::Actions
+  def index
+    respond_with index_collection, index_options
+  end
+
+  def show
+    respond_with root_resource(show_resource), show_options
+  end
+
+  def create
+    create_resource.tap do |res|
+      consume_with_content_type! res
+      hal_authorize res
+      res.save!
+      respond_with root_resource(res), show_options
+    end
+  end
+
+  def update
+    update_resource.tap do |res|
+      consume_with_content_type! res
+      hal_authorize res
+      res.save!
+      respond_with root_resource(res), show_options
+    end
+  end
+
+  def destroy
+    destroy_resource.tap do |res|
+      hal_authorize res
+      res.destroy
+      head :no_content
+    end
+  end
+
+  private
+
+  def destroy_redirect
+    { action: 'index' }
+  end
+
+  def index_options
+    valid_params_for_action(:index).tap do |options|
+      options[:_keys] = options.keys
+    end
+  end
+
+  def show_options
+    valid_params_for_action(:show).tap do |options|
+      options[:_keys] = options.keys
+      if self.class.resource_representer
+        options[:represent_with] = self.class.resource_representer
+      end
+    end
+  end
+
+  def valid_params_for_action(action)
+    (params.slice(*self.class.valid_params_list(action)) || {}).tap do |p|
+      p[:zoom] = zoom_param if zoom_param
+    end
+  end
+
+  def zoom_param
+    @zoom_param ||= begin
+      if (zp = params[:zoom]) && zp.present?
+        zp.split(',').map(&:strip).compact.sort
+      end
+    end
+  end
+
+  def root_resource(resource)
+    resource.tap { |res| res.is_root_resource = true }
+  end
+
+  # TODO: Remove this method when we upgrade roar-rails
+  # Background: https://github.com/apotonick/roar-rails/blob/a109b40/lib/roar/rails/controller_additions.rb#L27
+  def consume_with_content_type!(model, options = {})
+    type = request.content_type
+    format = Mime::Type.lookup(type).try(:symbol)
+
+    if format.blank?
+      raise HalApi::Errors::UnsupportedMediaType.new(type)
+    end
+
+    parse_method = compute_parsing_method(format)
+    representer = prepare_model_for(format, model, options)
+
+    representer.send(parse_method, incoming_string, options)
+    model
+  end
+
+  def hal_authorize(resource)
+    if respond_to?(:authorize)
+      authorize(resource)
+    else
+      define_singleton_method(:authorize, Proc.new(resource) do
+        true
+      end)
+      singleton_class.send(:alias_method, :hal_authorize, :authorize)
+    end
+  end
+
+
+  module ClassMethods
+    attr_accessor :valid_params
+
+    def allow_params(action, *params)
+      self.valid_params ||= {}
+      valid_params[action.to_sym] = Array(params).flatten
+    end
+
+    def valid_params_list(action)
+      (valid_params || {})[action.to_sym]
+    end
+  end
+end

data/lib/hal_api/controller/cache.rb

@@ -0,0 +1,34 @@
+module HalApi::Controller::Cache
+  private
+
+  def index_cache_path
+    HalApi::PagedCollection.new(
+      filtered(paged(sorted(scoped(resources_base)))),
+      request,
+      item_class: self.class.resource_class,
+      item_decorator: self.class.resource_representer
+    ).cache_key
+  end
+
+  def show_cache_path
+    show_resource.updated_at.utc.to_i
+  end
+
+  module ClassMethods
+    def cache_api_action(action, options = {})
+      options = cache_options.merge(options || {})
+      cache_path_method = options.delete(:cache_path_method)
+      cache_path_method ||= "#{action}_cache_path"
+      unless options[:cache_path]
+        options[:cache_path] = lambda do |c|
+          c.send(:valid_params_for_action, action).merge _c: send(cache_path_method)
+        end
+      end
+      caches_action(action, options)
+    end
+
+    def cache_options
+      { compress: true, expires_in: 1.hour, race_condition_ttl: 30 }
+    end
+  end
+end

data/lib/hal_api/controller/exceptions.rb

@@ -0,0 +1,43 @@
+require 'action_dispatch/http/request'
+require 'action_dispatch/middleware/exception_wrapper'
+
+# Since we are taking over exception handling, make sure we log exceptions
+# https://github.com/rails/rails/blob/4-2-stable/actionpack/lib/action_dispatch/middleware/debug_exceptions.rb
+module HalApi::Controller::Exceptions
+  def respond_with_error(exception)
+    wrapper = ::ActionDispatch::ExceptionWrapper.new(env, exception)
+    log_error(env, wrapper)
+
+    error = exception.is_a?(HalApi::Errors::ApiError) ? exception : HalApi::Errors::ApiError.new
+    respond_with(
+      error,
+      status: error.status,
+      represent_with: HalApi::Errors::Representer
+    )
+  end
+
+  def log_error(env, wrapper)
+    logger = env['action_dispatch.logger'] || ActiveSupport::Logger.new($stderr)
+    return unless logger
+
+    exception = wrapper.exception
+
+    trace = wrapper.application_trace
+    trace = wrapper.framework_trace if trace.empty?
+
+    ActiveSupport::Deprecation.silence do
+      message = "\n#{exception.class} (#{exception.message}):\n"
+      message << exception.annoted_source_code.to_s if exception.respond_to?(:annoted_source_code)
+      message << "  " << trace.join("\n  ")
+      logger.fatal("#{message}\n\n")
+    end
+  end
+
+  module ClassMethods
+    def hal_rescue_standard_errors
+      rescue_from StandardError do |error|
+        respond_with_error(error)
+      end
+    end
+  end
+end

data/lib/hal_api/controller/resources.rb

@@ -0,0 +1,135 @@
+module HalApi::Controller::Resources
+  private
+
+  # action specific resources
+
+  def index_collection
+    HalApi::PagedCollection.new(
+      resources,
+      request,
+      item_class: self.class.resource_class,
+      item_decorator: self.class.resource_representer
+    )
+  end
+
+  def show_resource
+    resource
+  end
+
+  def update_resource
+    resource
+  end
+
+  def create_resource
+    resource
+  end
+
+  def destroy_resource
+    resource
+  end
+
+  def resource
+    resource = instance_variable_get("@#{resource_name}")
+    return resource if resource
+
+    resource = if params[:id]
+      find_base.send(self.class.find_method, params[:id])
+    elsif request.post?
+      filtered(resources_base).build
+    end
+    raise HalApi::Errors::NotFound.new if resource.nil?
+    self.resource = resource
+  end
+
+  def resource=(res)
+    instance_variable_set("@#{resource_name}", res)
+  end
+
+  def resource_name
+    self.class.resource_class.name.underscore
+  end
+
+  # Plural resources
+
+  def resources
+    instance_variable_get("@#{resources_name}") ||
+      self.resources = decorate_query(resources_base)
+  end
+
+  def resources=(res)
+    instance_variable_set("@#{resources_name}", res)
+  end
+
+  def resources_name
+    resource_name.pluralize
+  end
+
+  def resources_base
+    self.class.resource_class.where(nil)
+  end
+
+  def find_base
+    filtered(scoped(included(resources_base)))
+  end
+
+  # Decorations
+
+  def decorate_query(res)
+    filtered(paged(sorted(scoped(res))))
+  end
+
+  def filtered(arel)
+    keys = self.class.resources_params || []
+    where_hash = params.slice(*keys)
+    if where_hash.key?('story_id')
+      where_hash['piece_id'] = where_hash.delete('story_id')
+    end
+    where_hash = where_hash.permit(where_hash.keys)
+    arel = arel.where(where_hash) unless where_hash.blank?
+    arel
+  end
+
+  def included(res)
+    res
+  end
+
+  def paged(arel)
+    arel.page(params[:page]).per(params[:per])
+  end
+
+  def scoped(res)
+    res
+  end
+
+  def sorted(arel)
+    arel.order(id: :desc)
+  end
+
+  module ClassMethods
+    attr_accessor :resource_class, :resources_params, :resource_representer, :find_method
+
+    def filter_resources_by(*rparams)
+      self.resources_params = rparams
+    end
+
+    def represent_with(representer_class)
+      self.resource_representer = representer_class
+    end
+
+    def find_method(new_method=nil)
+      if new_method.present?
+        @find_method = new_method
+      else
+        @find_method ||= :find
+      end
+    end
+
+    def resource_class
+      @resource_class ||= controller_name.classify.constantize.tap do |klass|
+        unless klass.included_modules.include?(HalApi::RepresentedModel)
+          klass.send(:include, HalApi::RepresentedModel)
+        end
+      end
+    end
+  end
+end