grapeful 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae3f0c43283001a1dd07a7b8e3082b3ab3826063
+  data.tar.gz: 05b40e23abc5e68652a072d50d402f2921513d7b
+SHA512:
+  metadata.gz: eb9c108e9d3026d57c7d67c264e5f140e116bcf41746a9039211fe429f45b44dbca8c295c2043d79631872c4ff37c8ef2833d55203a410faf4b381bfd2723d50
+  data.tar.gz: 53c116cf13b75b0a3e7be69fbb2ac5c254eccf1e4567786d8760b7ff6388408d1431439f00c3ef8e7bdd513ccb4459636f6d1652d189973e59881de2d154c5a3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grapeful.gemspec
+gemspec
+
+group :test do
+  gem "rack-test"
+  gem "rspec", "~> 2.14.1"
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Zoloo
+
+MIT License
+
+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,97 @@
+# Grapeful
+
+Customer Response builder for Grape.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grapeful'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grapeful
+
+## Usage
+Hello world example
+```ruby
+  class API < Grape::API
+    get :hello do
+      ful :hello, 'world'
+    end
+  end
+```
+The response will be
+```ruby
+  {
+    "hello": "world"
+  }
+```
+
+Using with ActiveRecord
+```ruby
+  class API < Grape::API
+    resources :users do
+      get '/' do
+        users = User.recent
+        ful :users, users
+        ful :total, users.length if current_user.admin?
+      end
+    end
+  end
+```
+The response will be
+```ruby
+  {
+    "users": [
+        {
+            "id": 21,
+            "name": "John Smith",
+            "uic": "john",
+            "role": "admin",
+            "created_at": "2013-08-14T10:12:30.933Z"
+        }
+    ],
+    "total": 1
+  }
+```
+
+Using with `active_model_serializers`
+```ruby
+  class API < Grape::API
+    resources :users do
+
+      params { requires :user, type: Hash, desc: 'User data' }
+      post '/' do
+        user = User.new(params[:user])
+        user.save!
+        ful :user, UserSerializer.new(user), message: 'The user was successfuly created.'
+      end
+    end
+  end
+```
+The response will be
+```ruby
+  {
+    "user": {
+            "id": 25,
+            "name": "Don Dan",
+            "uic": "don",
+            "role": "admin",
+            "created_at": "2013-08-14T10:12:30.933Z"
+    },
+    "message": "The user was successfully created."
+  }
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/grapeful.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grapeful/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grapeful"
+  spec.version       = Grapeful::VERSION
+  spec.authors       = ["Zolzaya E."]
+  spec.email         = ["zolzaya.erdenebaatar@gmail.com"]
+  spec.description   = "Custom Response builder for Grape"
+  spec.summary       = "Custom Response builder for Grape"
+  spec.homepage      = "https://github.com/zolzaya/grapeful"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "grape", "~> 0.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/grapeful/endpoint.rb

@@ -0,0 +1,19 @@
+module Grapeful
+  module Endpoint
+
+    def ful(*args)
+      options = args.count > 1 ? args.extract_options! : {}
+      key, object = if args.count == 2 && args.first.is_a?(Symbol)
+                      args
+                    else
+                      [nil, args.first]
+                    end
+      @data ||= Hash.new
+      @data[key] = object if key
+      @data.merge!(options)
+      body @data
+    end
+  end
+end
+
+Grape::Endpoint.send(:include, Grapeful::Endpoint)

data/lib/grapeful/version.rb

@@ -0,0 +1,3 @@
+module Grapeful
+  VERSION = "0.0.1"
+end

data/lib/grapeful.rb

@@ -0,0 +1,3 @@
+require "grape"
+require "grapeful/version"
+require "grapeful/endpoint"

data/spec/grapeful_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Grapeful do
+  subject do
+    Class.new(Grape::API)
+  end
+
+  before do
+    subject.format :json
+  end
+
+  def app
+    subject
+  end
+
+  it 'should work without grapeful' do
+    subject.get("/home") {"Hello World"}
+    get "/home"
+    last_response.body.should == "\"Hello World\""
+  end
+
+  describe "#ful" do
+    it 'ful' do
+      subject.get('/users') do
+        @user = OpenStruct.new(name: "Bob Marlin")
+        ful :user, @user
+        ful :fff, 'fffff', root: 'users'
+        ful :message, 'foo bar me'
+      end
+
+      get '/users'
+      last_response.body.should == "{\"user\":\"#<OpenStruct name=\\\"Bob Marlin\\\">\",\"fff\":\"fffff\",\"root\":\"users\",\"message\":\"foo bar me\"}"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rspec'
+require 'rack/test'
+require 'grape'
+require 'grapeful'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Include Rack::Test
+  config.include Rack::Test::Methods
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: grapeful
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Zolzaya E.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Custom Response builder for Grape
+email:
+- zolzaya.erdenebaatar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grapeful.gemspec
+- lib/grapeful.rb
+- lib/grapeful/endpoint.rb
+- lib/grapeful/version.rb
+- spec/grapeful_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/zolzaya/grapeful
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Custom Response builder for Grape
+test_files:
+- spec/grapeful_spec.rb
+- spec/spec_helper.rb