braque-hypermedia_responses_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6c2ff0fd1edcd31e21f91409842f86b8f55a0ca
+  data.tar.gz: 702eb2a22654ff3fdb39ddd51417d0606448ea45
+SHA512:
+  metadata.gz: 3e1ba35d690f4648d5111234b481ec7a992af8e8d2e2e6c3b28ca20cda6e1519ee6e1bc5df6506efc8bf65be8623ddd54b5e200fd138f3ed494665e90c46cd80
+  data.tar.gz: f610f9cc29b9f51b51c163e3a2eeb0b2e546aabdc5aaa0a799fc5f08cd110cf60c6cfd8f79e570b27921dc2896faffac5f27b676ab5c9ab0e55b6e076d222ce2

data/.gitignore

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

data/.rspec

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

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 braque-hypermedia_responses_helpers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dylan Fareed
+
+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,28 @@
+# Braque::HypermediaResponsesHelpers
+
+A collection of helpers to mock hypermedia API endpoints for Braque::Model classes.
+
+Extracted from and best used in collaboration with [Braque](https://github.com/dylanfareed/braque).
+
+[![Build Status](https://semaphoreci.com/api/v1/projects/ca636418-1e03-4916-9a71-9cd25ad3e148/533471/badge.svg)](https://semaphoreci.com/dylanfareed/braque-hypermedia_responses_helpers)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'braque-hypermedia_responses_helpers'
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dylanfareed/braque-hypermedia_responses_helpers. 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,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 "braque/hypermedia_responses_helpers"
+
+# 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/braque-hypermedia_responses_helpers.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'braque/hypermedia_responses_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'braque-hypermedia_responses_helpers'
+  spec.version       = Braque::HypermediaResponsesHelpers::VERSION
+  spec.authors       = ['Dylan Fareed']
+  spec.email         = ['email@dylanfareed.com']
+
+  spec.summary       = 'A collection of helpers for Braque to mock hypermedia API endpoints.'
+  spec.description   = 'A collection of helpers for Braque to mock hypermedia API endpoints.'
+  spec.homepage      = 'https://github.com/dylanfareed/braque-hypermedia_responses_helpers'
+  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_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'braque', '~> 0.1.8'
+end

data/lib/braque/hypermedia_responses_helpers.rb

@@ -0,0 +1,64 @@
+require 'braque/hypermedia_responses_helpers/version'
+
+module Braque
+  module HypermediaResponsesHelpers
+    # For a given Braque::Model class, mock a root endpoint.
+    #
+    def hypermedia_root_json_for(hyperclient_model_class, options = {})
+      collection_query_options = options[:collection_query] || '{?page,size}'
+      resource_path_options = options[:resource_path] || '{id}'
+      root_hash = {}
+      root_hash[:_links] = {}
+      root_hash[:_links][:self] = { href: hyperclient_model_class.config[:api_root_url] }
+      root_hash[:_links][hyperclient_model_class.collection_method_name] = { href: "#{hyperclient_model_class.config[:api_root_url]}/#{hyperclient_model_class.collection_method_name}#{collection_query_options}", templated: true }
+      root_hash[:_links][hyperclient_model_class.instance_method_name] = { href: "#{hyperclient_model_class.config[:api_root_url]}/#{hyperclient_model_class.collection_method_name}/#{resource_path_options}", templated: true }
+      JSON.parse root_hash.to_json
+    end
+
+    # For a given Braque::Model class, mock a collection endpoint response.
+    #
+    def hypermedia_collection_json_for(hyperclient_model_collection, options = {})
+      hyperclient_model = hyperclient_model_collection.first
+      collection_hash = {}
+      collection_hash[:total_count] = 1
+      collection_hash[:total_pages] = 1
+      collection_hash[:current_page] = 1
+      collection_hash[:_links] = {}
+      collection_hash[:_links][:self] = { href: "#{hyperclient_model.class.config[:api_root_url]}/#{hyperclient_model.class.collection_method_name}" }
+      collection_hash[:_links][:next] = { href: "#{hyperclient_model.class.config[:api_root_url]}/#{hyperclient_model.class.collection_method_name}" }
+      collection_hash[:_links][:prev] = { href: "#{hyperclient_model.class.config[:api_root_url]}/#{hyperclient_model.class.collection_method_name}" }
+      collection_hash[:_embedded] = {}
+      collection_hash[:_embedded][hyperclient_model.class.collection_method_name] = embedded_elements_for_collection(hyperclient_model_collection, options)
+      JSON.parse collection_hash.to_json
+    end
+
+    # For a given Braque::Model class, mock a resource endpoint response.
+    #
+    def hypermedia_resource_json_for(hyperclient_model, options = {})
+      resource_hash = embedded_element(hyperclient_model, options)
+      JSON.parse resource_hash.to_json
+    end
+
+    private
+
+    def embedded_elements_for_collection(hyperclient_model_collection, options = {})
+      embedded_elements = []
+      hyperclient_model_collection.each do |model|
+        embedded_elements << embedded_element(model, options)
+      end
+      embedded_elements
+    end
+
+    def embedded_element(model, options = {})
+      resource_path_str = eval(options[:resource_path].to_s) if options[:resource_path]
+      resource_path = resource_path_str || model.id
+      hyperclient_element = {}
+      model.attributes.each_key do |key|
+        hyperclient_element[key] = model.send(key)
+      end
+      hyperclient_element[:_links] = {}
+      hyperclient_element[:_links][:self] = { href: "#{model.class.config[:api_root_url]}/#{model.class.collection_method_name}/#{resource_path}" }
+      hyperclient_element
+    end
+  end
+end

data/lib/braque/hypermedia_responses_helpers/version.rb

@@ -0,0 +1,5 @@
+module Braque
+  module HypermediaResponsesHelpers
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: braque-hypermedia_responses_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dylan Fareed
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-07 00:00:00.000000000 Z
+dependencies:
+- !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: braque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.8
+description: A collection of helpers for Braque to mock hypermedia API endpoints.
+email:
+- email@dylanfareed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- braque-hypermedia_responses_helpers.gemspec
+- lib/braque/hypermedia_responses_helpers.rb
+- lib/braque/hypermedia_responses_helpers/version.rb
+homepage: https://github.com/dylanfareed/braque-hypermedia_responses_helpers
+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.8
+signing_key: 
+specification_version: 4
+summary: A collection of helpers for Braque to mock hypermedia API endpoints.
+test_files: []