beyond_the_api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 191662efe7dc972b83e5ca4ad9f5253093b3b7be
+  data.tar.gz: 4c5c7a8cd7aaebef6f6a6d994ae70138f0b6d40d
+SHA512:
+  metadata.gz: d4f3ea8b6bce79cd51756b22c3719aea00e033fd44585a9338d74b88f535cff5f4ecd6988b37b50348e9856967c182f8cbff61459bd46eb7fdd4db735d1172e1
+  data.tar.gz: c6198f9a81eb69ef1efbaea793368a8819c47af42f7df653bfa02fb926364f0b6ef9d9894c3819ba89ff4f279d9a391b0b2cc4c61bc047e454c681b4f4c2af8f

data/.gitignore

@@ -0,0 +1,19 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history
+
+*.gem

data/.rubocop.yml

@@ -0,0 +1,60 @@
+AllCops:
+  DisabledByDefault: false
+  TargetRubyVersion: 2.3
+  Exclude:
+    - db/migrate/*
+    - db/schema.rb
+    - lib/generators/**/*
+    - lib/rails/generators/**/*
+    - lib/populate/**/*
+    - bin/*
+Rails:
+  Enabled: true
+Metrics/LineLength:
+  Max: 100
+Metrics/ClassLength:
+  CountComments: false
+  Max: 100
+  Exclude:
+    - test/**/*
+Metrics/ClassLength:
+  CountComments: false
+  Max: 300
+  Include:
+    - test/**/*
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - test/**/*
+Metrics/BlockLength:
+  Enabled: false
+  Include:
+    - test/**/*
+Style/PredicateName:
+  Enabled: true
+  Exclude:
+    - test/support/shoulda/**/*
+Style/PredicateName:
+  Enabled: false
+  Include:
+    - test/support/shoulda/**/*
+Style/AsciiComments:
+  Enabled: false
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/ModuleFunction:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/StringLiterals:
+  Enabled: false
+Style/WordArray:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 William Weckl
+
+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,58 @@
+# Beyond The API Test Helpers
+
+Beyond The API is a framework created to standardize Rails APIs and make things easier.
+
+This gem consist in various render helpers to help render JSON on common use cases like pagination and sort.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'beyond_the_api', '~> 0.0.1'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Installation
+
+Include in your application_controller.rb or whatever controller you want to use the helpers:
+```ruby
+include BeyondTheApi::RenderHelpers
+```
+
+## Usage
+
+#### Base
+
+* json patterns
+* meta
+* model serializer helper
+* current_user
+* versioning
+
+#### Index renders
+
+* total_count
+* total_pages
+* pagination
+* filters
+* sort
+
+#### Show renders
+
+TODO
+
+#### Common renders
+
+TODO
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/williamweckl/beyond_the_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/beyond_the_api.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'beyond_the_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'beyond_the_api'
+  spec.version       = BeyondTheApi::VERSION
+  spec.authors       = ['William Weckl']
+  spec.email         = ['william.weckl@gmail.com']
+
+  spec.summary       = 'API patterns over Rails API.'
+  spec.description   = 'API patterns over Rails API.'
+  spec.homepage      = 'http://rubygems.org/gems/beyond_the_api'
+  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 'active_model_serializers', '~> 0.10.3'
+  spec.add_dependency 'activesupport', '>= 4.2', '< 5.1'
+  spec.add_dependency 'will_paginate', '~> 3.1.5'
+  spec.add_dependency 'versionist', '~> 1.5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/config.reek

@@ -0,0 +1,63 @@
+---
+### Generic smell configuration
+
+IrresponsibleModule:
+  enabled: false
+UnusedPrivateMethod:
+  enabled: false
+NilCheck:
+  enabled: false
+
+"app/controllers":
+  TooManyStatements:
+    max_statements: 10
+  NestedIterators:
+    max_allowed_nesting: 2
+  UnusedPrivateMethod:
+    enabled: false
+  UncommunicativeModuleName:
+    enabled: false
+  InstanceVariableAssumption:
+    enabled: false
+  ManualDispatch:
+    enabled: false
+"app/helpers":
+  UtilityFunction:
+    enabled: false
+  FeatureEnvy:
+    enabled: false
+  ManualDispatch:
+    enabled: false
+"app/models":
+  Attribute:
+    enabled: false
+"app/serializer":
+  RepeatedConditional:
+    enabled: false
+"test/support":
+  UtilityFunction:
+    enabled: false
+  FeatureEnvy:
+    enabled: false
+  TooManyStatements:
+    max_statements: 10
+  InstanceVariableAssumption:
+    enabled: false
+  TooManyMethods:
+    max_methods: 20
+  ManualDispatch:
+    enabled: false
+  DataClump:
+    enabled: false
+"test/requests":
+  UncommunicativeModuleName:
+    enabled: false
+
+### Excluding directories
+
+# Directories below will not be scanned at all
+exclude_paths:
+  - db/migrate
+  - lib/generators
+  - lib/rails/generators
+  - lib/populate

data/lib/beyond_the_api/index_render_helpers.rb

@@ -0,0 +1,85 @@
+require 'will_paginate/array'
+module BeyondTheApi
+  module IndexRenderHelpers
+    API_DEFAULT_PAGE_SIZE = 10
+
+    protected
+
+    ## Index ##
+
+    def render_json_list(list, options = {})
+      @list = list
+      @list = paginate(options[:default_page_size] || API_DEFAULT_PAGE_SIZE)
+      @meta[:total_pages] = (options[:total_pages] || @list.total_pages) if total_pages?
+      @meta[:total_count] ||= (options[:total_count] || @list.count) if total_count?
+
+      render index_params_to_render(options)
+    end
+
+    def index_params_to_render(options)
+      params_to_render = { json: @list, meta: @meta, current_user: current_user }
+      serializer = options[:serializer]
+      params_to_render[:each_serializer] = serializer if serializer
+      params_to_render
+    end
+
+    def render_json_list_enum(list, name, options = {})
+      @list = list
+      @list = paginate_array(options[:default_page_size] || API_DEFAULT_PAGE_SIZE)
+      @meta[:total_count] = @list.count if total_count?
+      @meta[:total_pages] = @list.total_pages if total_pages?
+      render json: {
+        name => @list,
+        meta: @meta
+      }
+    end
+
+    def paginate(default)
+      return @list unless paginate?(default)
+      @list.page(page).per_page(params[:per_page] || default)
+    end
+
+    def paginate_array(default)
+      return @list unless paginate?(default)
+      @list.paginate(page: page, per_page: params[:per_page] || default)
+    end
+
+    def apply_filters(list, *scopes)
+      scopes.each do |scope|
+        param_name = scope.to_s.sub('by_', '')
+        param = params[param_name]
+        list = list.send(scope, param) if param.present? && list.respond_to?(scope)
+      end
+      list
+    end
+
+    def enum_list_to_array_hashes(list)
+      array = []
+      list.each do |name, id|
+        array << {
+          id: id,
+          name: name
+        }
+      end
+      array
+    end
+
+    private
+
+    def total_pages?
+      @list.respond_to?(:total_pages) && params[:total_pages].to_s == 'true'
+    end
+
+    def total_count?
+      params[:total_count].to_s == 'true'
+    end
+
+    def page
+      params[:page] || 1
+    end
+
+    def paginate?(default)
+      params[:per_page] || !default == :unlimited
+    end
+  end
+end

data/lib/beyond_the_api/render_helpers.rb

@@ -0,0 +1,46 @@
+module BeyondTheApi
+  module RenderHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      include ::BeyondTheApi::IndexRenderHelpers
+      include ::BeyondTheApi::ShowRenderHelpers
+      before_action :set_meta
+    end
+
+    def render_json_message_with_serializer(object, options = {})
+      hash = serialized_object_with_root(object, options[:serializer_root])
+      hash.merge!(options[:message])
+      hash[:meta] = @meta
+      render json: hash, status: (options[:status] || :ok)
+    end
+
+    def render_json_message(hash, status, optionals = {})
+      hash = hash.merge(meta: @meta)
+      hash = hash.merge(optionals)
+      render json: hash, status: status
+    end
+
+    def render_json_errors(object)
+      errors = object.errors
+      render json: { errors: errors.messages,
+                     full_error_messages: errors.full_messages, meta: @meta }, status: 422
+    end
+
+    private
+
+    def set_meta
+      @meta ||= {}
+      @meta[:version] = params[:controller].split('/').first
+      @meta[:now] = Time.current
+    end
+
+    def serialized_object_with_root(object, root)
+      options = {}
+      options[:current_user] = current_user if respond_to?(:current_user)
+
+      root ||= object.class.to_s.underscore
+      { root => object.serialize_to_json(options) }
+    end
+  end
+end

data/lib/beyond_the_api/show_render_helpers.rb

@@ -0,0 +1,24 @@
+module BeyondTheApi
+  module ShowRenderHelpers
+    def render_json_serializer(object, options = {})
+      render_params = { json: object, current_user: current_user, meta: @meta,
+                        status: (options[:status] || :ok) }
+
+      render render_params.merge(render_json_serializer_aditional_params(options))
+    end
+
+    def render_json_serializer_aditional_params(options)
+      render_params = {}
+      render_params[:root] = options[:root].presence
+      render_params[:serializer] = options[:serializer].presence
+      render_params.delete_if { |_key, value| !value }
+    end
+
+    def render_json_object(object, name)
+      render json: {
+        name => object,
+        meta: @meta
+      }
+    end
+  end
+end

data/lib/beyond_the_api/version.rb

@@ -0,0 +1,3 @@
+module BeyondTheApi
+  VERSION = '0.0.1'
+end

data/lib/beyond_the_api.rb

@@ -0,0 +1,14 @@
+require 'active_model_serializers'
+require 'will_paginate'
+require 'versionist'
+require 'beyond_the_api/render_helpers'
+require 'beyond_the_api/index_render_helpers'
+require 'beyond_the_api/show_render_helpers'
+
+ActiveRecord::Base.class_eval do
+  def serialize_to_json(serializer_options = {})
+    serialization = ActiveModelSerializers::SerializableResource.new(self,
+                                                                     serializer_options)
+    JSON.parse(serialization.to_json).values[0]
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: beyond_the_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- William Weckl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: versionist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.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'
+description: API patterns over Rails API.
+email:
+- william.weckl@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- LICENSE.txt
+- README.md
+- beyond_the_api.gemspec
+- config.reek
+- lib/beyond_the_api.rb
+- lib/beyond_the_api/index_render_helpers.rb
+- lib/beyond_the_api/render_helpers.rb
+- lib/beyond_the_api/show_render_helpers.rb
+- lib/beyond_the_api/version.rb
+homepage: http://rubygems.org/gems/beyond_the_api
+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.6.7
+signing_key: 
+specification_version: 4
+summary: API patterns over Rails API.
+test_files: []