rails_api_response 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b066361b714562c86f833d37c7a8aa3db621ecdf
+  data.tar.gz: 408c68b4102e9ccf96aa17b3adb5df9be860096c
+SHA512:
+  metadata.gz: 3cfde9a86a413c9c200ffbbb5131b903a43334e0d85041fb07eae0d38c9c881d1c3fe9109ce80f2b3ab508f4f2539ada01ee020aee3c392f64e7f84a70c3e3b2
+  data.tar.gz: 9d47f3540f70b002a1277b93abf7641331d9e2e2481e66febf9d8cb80be96512da2d97df38f0b02b78d9a4d99a498f04d57745fa60d98218c7bd41006e54e756

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+# ApiResponse
+
+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/api_response`. 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 'api_response'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_response
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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]/api_response.
+
+# api-response

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/api_response.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_response/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_api_response"
+  spec.version       = ApiResponse::VERSION
+  spec.authors       = ["Vinh Chau"]
+  spec.email         = ["cpvinh@gmail.com"]
+
+  spec.summary       = "The gem for rails framework to modify the api response"
+  spec.description   = "The gem for rails framework to modify the api response"
+  spec.homepage      = "https://github.com/vinhcp/api-response"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "https://rubygems.org/gems/api-response"
+  #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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

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

@@ -0,0 +1,12 @@
+require "api_response/version"
+
+module Core
+  module ControllerHelpers
+    autoload :ResponseTemplate, 'core/controller_helpers/response_template'
+    autoload :Responses, 'core/controller_helpers/responses'
+  end
+end
+
+module ApiResponse
+  # Your code goes here...
+end

data/lib/api_response/version.rb

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

data/lib/core/controller_helpers/response_template.rb

@@ -0,0 +1,30 @@
+module ResponseTemplate
+  def self.template(code, metadata, data={})
+    response = { code: code, metadata: metadata, data: data }
+
+    Rails.logger.info Time.zone
+    Rails.logger.info response
+
+    response
+  end
+
+  def self.success(metadata, data = {})
+    template(200, metadata, data)
+  end
+
+  def self.create_success(metadata, data = {})
+    template(201, metadata, data)
+  end
+
+  def self.error_credential(metadata, data = {})
+    template(401, metadata, data)
+  end
+
+  def self.error_not_found(metadata, data = {})
+    template(404, metadata, data)
+  end
+
+  def self.error(metadata, data = {})
+    template(500, metadata, data)
+  end
+end

data/lib/core/controller_helpers/responses.rb

@@ -0,0 +1,54 @@
+module Core
+  module ControllerHelpers
+    module Responses
+
+      # Response methods
+      def respond_success(message: '', data: {})
+        render json: ResponseTemplate.success(message_metadata(message), data)
+      end
+
+      def respond_error(message: '', instance: nil, data: {})
+        metadata = instance.present? ? error_instance_metadata(instance) : message_metadata(message)
+        render json: ResponseTemplate.error(metadata, data)
+      end
+
+      def respond_create_success(message: "", data: {})
+        render json: ResponseTemplate.create_success(message_metadata(message), data)
+      end
+
+      def respond_error_credential(message:, data: {})
+        render json: ResponseTemplate.error_credential(message_metadata(message), data)
+      end
+
+      def respond_error_not_found(message:, data: {})
+        render json: ResponseTemplate.error_not_found(message_metadata(message), data)
+      end
+
+      def respond_json(code: 200, message: '', data: {})
+        render json: ResponseTemplate.template(code, message_metadata(message), data)
+      end
+
+      private
+
+      # Convert instance to error metadata
+      def error_instance_metadata(instance)
+        errors = []
+        instance.errors.to_hash.each do |k,v|
+          errors << {
+            field: k.to_s,
+            description: v
+          }
+        end
+        {
+          message: instance.errors.full_messages,
+          errors: errors
+        }
+      end
+
+      # Convert message text to error metadata
+      def message_metadata(message)
+        { message: message }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: rails_api_response
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vinh Chau
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: The gem for rails framework to modify the api response
+email:
+- cpvinh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- api_response.gemspec
+- bin/console
+- bin/setup
+- lib/api_response.rb
+- lib/api_response/version.rb
+- lib/core/controller_helpers/response_template.rb
+- lib/core/controller_helpers/responses.rb
+homepage: https://github.com/vinhcp/api-response
+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: The gem for rails framework to modify the api response
+test_files: []
+has_rdoc: