napa_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: baa8fd351d63e02420301af383a7447ad0d6a9f5
+  data.tar.gz: 8e0e6d2d3bc336dd5e6ac205354731b21b52ed73
+SHA512:
+  metadata.gz: 924b4e91038d3ccdd8eb7cc8f52c92a2fe519c6499840afb474c70731fc4f381e1e77c26799cdecf8d48d73d234010bdcb56c98c97997cb22760e87a880801b9
+  data.tar.gz: 72fd1c9a3f6ff8e5b111187ddbb3dbc4eb3f9a242e238a89af3bd2709f8613c370f45d8ed016d5795c7280ab923cebe34c999dee675e16743146515055b5b870

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/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+master
+===
+
+0.1.0
+===
+* Add grape_extensions folder with error_formatter and grape_helpers
+* Add output_formatters folder with include_nil, pagination, representer
+* Add rspec_extensions with response_helpers
+* Add json_error
+* Add kaminari, grape and roar dependency

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+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 @@
+# NapaRails
+
+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/napa_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 'napa_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install napa_rails
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/napa_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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 "napa_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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/napa/grape_extensions/error_formatter.rb

@@ -0,0 +1,18 @@
+if defined?(Grape)
+  module Grape
+    module ErrorFormatter
+      module Json
+        class << self
+          def call(message, backtrace, options = {}, _env = nil)
+            result = message.is_a?(Napa::JsonError) ? message : Napa::JsonError.new(:api_error, message)
+
+            if (options[:rescue_options] || {})[:backtrace] && backtrace && !backtrace.empty?
+              result = result.to_h.merge(backtrace: backtrace)
+            end
+            MultiJson.dump(result)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/napa/grape_extensions/grape_helpers.rb

@@ -0,0 +1,65 @@
+module Napa
+  module GrapeHelpers
+    def represent(data, with: nil, **args)
+      fail ArgumentError, ':with option is required' if with.nil?
+
+      if data.respond_to?(:map)
+        return { data: data.map { |item| with.new(item).to_hash(args) } }
+      else
+        return { data: with.new(data).to_hash(args) }
+      end
+    end
+
+    def present_error(code, message = '', reasons = {})
+      Napa::JsonError.new(code, message, reasons)
+    end
+
+    def permitted_params(options = {})
+      options = { include_missing: false }.merge(options)
+      declared(params, options)
+    end
+
+    def paginate(data, with: nil, **args)
+      raise ArgumentError.new(":with option is required") if with.nil?
+
+      if data.respond_to?(:to_a)
+        return {}.tap do |r|
+          data = Napa::Pagination.new(represent_pagination(data))
+          r[:data] = data.map{ |item| with.new(item).to_hash(args) }
+          r[:pagination] = data.to_h
+        end
+      else
+        return { data: with.new(data).to_hash(args) }
+      end
+    end
+
+    def represent_pagination(data)
+      # don't paginate if collection is already paginated
+      return data if data.respond_to?(:total_count)
+
+      page      = params.try(:page) || 1
+      per_page  = params.try(:per_page) || 25
+
+      order_by_params!(data) if data.is_a?(ActiveRecord::Relation) && data.size > 0
+
+      if data.is_a?(Array)
+        Kaminari.paginate_array(data).page(page).per(per_page)
+      else
+        data.page(page).per(per_page)
+      end
+    end
+
+    def order_by_params!(data)
+      if params[:sort_by] && data.column_names.map(&:to_sym).include?(params[:sort_by].to_sym)
+        sort_order = params[:sort_order] || :asc
+        data.order!(params[:sort_by] => sort_order.to_sym)
+      end
+      data
+    end
+
+    # extend all endpoints to include this
+    Grape::Endpoint.send :include, self if defined?(Grape)
+    # rails 4 controller concern
+    extend ActiveSupport::Concern if defined?(Rails)
+  end
+end

data/lib/napa/json_error.rb

@@ -0,0 +1,24 @@
+module Napa
+  class JsonError
+    def initialize(code, message, reasons = {})
+      @code = code
+      @message = message
+      @reasons = reasons
+    end
+
+    def to_json(options = {})
+      to_h.to_json(options)
+    end
+
+    def to_h
+      e = {
+        error: {
+          code: @code,
+          message: @message
+        }
+      }
+      e[:error][:reasons] = @reasons if @reasons.present?
+      e
+    end
+  end
+end

data/lib/napa/output_formatters/include_nil.rb

@@ -0,0 +1,16 @@
+# include this in your representer, and you will always return all defined keys (even if their value is nil)
+module Napa
+  module Representable
+    module IncludeNil
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def property(name, options = {}, &block)
+          super(name, options.merge(render_nil: true), &block)
+        end
+      end
+    end
+  end
+end

data/lib/napa/output_formatters/pagination.rb

@@ -0,0 +1,27 @@
+module Napa
+  class Pagination
+    include Enumerable
+    def initialize(object)
+      @object = object
+    end
+
+    def to_json(options = {})
+      to_h.to_json(options)
+    end
+
+    def to_h
+      {}.tap do |p|
+        p[:page]          = @object.current_page  if @object.respond_to?(:current_page)
+        p[:per_page]      = @object.limit_value   if @object.respond_to?(:limit_value)
+        p[:total_pages]   = @object.total_pages   if @object.respond_to?(:total_pages)
+        p[:total_count]   = @object.total_count   if @object.respond_to?(:total_count)
+      end
+    end
+
+    def each(&block)
+      @object.each do |member|
+        block.call(member)
+      end
+    end
+  end
+end

data/lib/napa/output_formatters/representer.rb

@@ -0,0 +1,24 @@
+require 'roar/decorator'
+require 'roar/version'
+
+if Roar::VERSION >= '1.0.0'
+  require 'roar/json'
+  require 'roar/coercion'
+else
+  require 'roar/representer/json'
+  require 'roar/representer/feature/coercion'
+end
+
+module Napa
+  class Representer < Roar::Decorator
+    include Coercion
+
+    if Roar::VERSION >= '1.0.0'
+      include Roar::JSON
+    else
+      include Roar::Representer::JSON
+    end
+
+    property :object_type, getter: ->(*) { self.class.name.underscore }
+  end
+end

data/lib/napa/rspec_extensions/response_helpers.rb

@@ -0,0 +1,50 @@
+module Napa
+  module RspecExtensions
+    module ResponseHelpers
+      def parsed_response
+        Hashie::Mash.new(JSON.parse(last_response.body))
+      end
+
+      def response_code
+        last_response.status
+      end
+
+      def response_body
+        last_response.body
+      end
+
+      def result_count
+        parsed_response.data.count
+      end
+
+      def first_result
+        parsed_response.data.first
+      end
+
+      def result_with_id(id)
+        parsed_response.data.select { |r| r.id == id }.first
+      end
+
+      def expect_count_of(count)
+        expect(result_count).to eq(count)
+      end
+
+      def expect_error_code(error_code)
+        expect(parsed_response.error.code).to eq(error_code.to_s)
+      end
+
+      def expect_only(object)
+        expect_count_of 1
+        expect(first_result.id).to eq(object.id)
+      end
+
+      def expect_to_have(object)
+        expect(!result_with_id(object.id).nil?).to be_truthy
+      end
+
+      def expect_to_not_have(object)
+        expect(!result_with_id(object.id).nil?).to be_falsy
+      end
+    end
+  end
+end

data/lib/napa/version.rb

@@ -0,0 +1,3 @@
+module Napa
+  VERSION = "0.1.0"
+end

data/lib/napa.rb

@@ -0,0 +1,13 @@
+require "grape"
+require "kaminari"
+require "napa/version"
+require "napa/rspec_extensions/response_helpers"
+require "napa/output_formatters/include_nil"
+require "napa/output_formatters/representer"
+require "napa/output_formatters/pagination"
+require "napa/grape_extensions/grape_helpers"
+require "napa/grape_extensions/error_formatter"
+require "napa/json_error"
+
+module Napa
+end

data/napa_rails.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'napa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "napa_rails"
+  spec.version       = Napa::VERSION
+  spec.authors       = ["Darby Frey, Flori Garcia"]
+  spec.email         = ["darby@bellycard.com, flori@bellycard.com"]
+
+  spec.summary       = %q{Napa features for Rails}
+  spec.description   = %q{Napa features for Rails}
+  spec.homepage      = "https://github.com/bellycard/napa_rails"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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 "grape"
+  spec.add_dependency "kaminari"
+  spec.add_dependency 'roar', ['>= 0.12.0', '< 2.0']
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: napa_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Darby Frey, Flori Garcia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  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: kaminari
+  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: roar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Napa features for Rails
+email:
+- darby@bellycard.com, flori@bellycard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/napa.rb
+- lib/napa/grape_extensions/error_formatter.rb
+- lib/napa/grape_extensions/grape_helpers.rb
+- lib/napa/json_error.rb
+- lib/napa/output_formatters/include_nil.rb
+- lib/napa/output_formatters/pagination.rb
+- lib/napa/output_formatters/representer.rb
+- lib/napa/rspec_extensions/response_helpers.rb
+- lib/napa/version.rb
+- napa_rails.gemspec
+homepage: https://github.com/bellycard/napa_rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Napa features for Rails
+test_files: []