hal_api-rails 0.2.0

data/lib/hal_api/representer/uri_methods.rb

@@ -0,0 +1,108 @@
+# encoding: utf-8
+
+require 'active_support/concern'
+
+# expects underlying model to have filename, class, and id attributes
+module HalApi::Representer::UriMethods
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    attr_accessor :profile_host, :alternate_host
+
+    def self_link
+      link(:self) do
+        {
+          href: self_url(represented),
+          profile: model_uri(represented)
+        }
+      end
+    end
+
+    def profile_link
+      link(:profile) { model_uri(represented) }
+    end
+
+    def alternate_link
+      link :alternate do
+        {
+          href: alternate_url(model_path(represented)),
+          type: 'text/html'
+        }
+      end
+    end
+  end
+
+  def model_path(represented)
+    rep = becomes_represented_class(represented)
+    class_path = rep.class.name.underscore.pluralize
+    "#{class_path}/#{represented.id}"
+  end
+
+  def self_url(represented)
+    rep = becomes_represented_class(represented)
+    polymorphic_path([:api, rep])
+  end
+
+  def becomes_represented_class(rep)
+    return rep unless rep.respond_to?(:becomes)
+    klass = rep.try(:item_class) || rep.class.try(:base_class)
+    (klass && (klass != rep.class)) ? rep.becomes(klass) : rep
+  end
+
+  def alternate_url(*path)
+    "https://#{self.class.alternate_host}/#{path.map(&:to_s).join('/')}"
+  end
+
+  def model_uri(*args)
+    "http://#{self.class.profile_host}/model/#{joined_names(args)}"
+  end
+
+  alias_method :profil_url, :model_uri
+
+  def joined_names(args)
+    (Array(args.map { |arg| model_uri_part_to_string(arg) }) +
+      model_uri_suffix(args)).flatten.compact.join('/')
+  end
+
+  def model_uri_suffix(args)
+    represented = args.last
+    klass = represented.try(:item_decorator) || self.class
+    klass.name.deconstantize.underscore.dasherize.split('/')[1..-1] || []
+  end
+
+  def model_uri_part_to_string(part)
+    if part.is_a?(String) || part.is_a?(Symbol)
+      part.to_s.dasherize
+    else
+      klass = part.is_a?(Class) ? part : (part.try(:item_class) || part.class)
+      if klass.respond_to?(:base_class) && (klass.superclass != ActiveRecord::Base)
+        base = klass.superclass.name.underscore.dasherize
+        child = klass.name.underscore.gsub(/_#{base}$/, "").dasherize
+        [base, child]
+      else
+        klass.name.underscore.dasherize
+      end
+    end
+  end
+
+  def method_missing(method_name, *args, &block)
+    if method_name.to_s.ends_with?('_path_template')
+      original_method_name = method_name[0..-10]
+      template_named_path(original_method_name, *args)
+    else
+      super(method_name, *args, &block)
+    end
+  end
+
+  def template_named_path(named_path, options)
+    replace_options = options.keys.inject({}) do |s, k|
+      s[k] = "_#{k.upcase}_REPLACE_"
+      s
+    end
+    path = send(named_path, replace_options)
+    replace_options.keys.each do |k|
+      path.gsub!(replace_options[k], (options[k] || ''))
+    end
+    path
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: hal_api-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Chris Rhoden
+- Andrew Kuklewicz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: roar-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: multi_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: minitest
+  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: JSON HAL APIs on Rails in the style of PRX v4. Uses ROAR
+email:
+- carhoden@gmail.com
+- andrew@beginsinwonder.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hal_api-rails.gemspec
+- lib/hal_api.rb
+- lib/hal_api/controller.rb
+- lib/hal_api/controller/actions.rb
+- lib/hal_api/controller/cache.rb
+- lib/hal_api/controller/exceptions.rb
+- lib/hal_api/controller/resources.rb
+- lib/hal_api/errors.rb
+- lib/hal_api/paged_collection.rb
+- lib/hal_api/rails.rb
+- lib/hal_api/rails/version.rb
+- lib/hal_api/represented_model.rb
+- lib/hal_api/representer.rb
+- lib/hal_api/representer/caches.rb
+- lib/hal_api/representer/caches/serialized_json.rb
+- lib/hal_api/representer/curies.rb
+- lib/hal_api/representer/embeds.rb
+- lib/hal_api/representer/format_keys.rb
+- lib/hal_api/representer/link_serialize.rb
+- lib/hal_api/representer/uri_methods.rb
+homepage: https://www.github.com/PRX/
+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
+signing_key: 
+specification_version: 4
+summary: JSON HAL APIs on Rails in the style of PRX
+test_files: []