grape-order 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87c5bc99ba99485f575a497989509f3dfcb44043
+  data.tar.gz: 714bc5c8147175c18e8bf52cdb581125653bb650
+SHA512:
+  metadata.gz: 9e100b26cef49973d7a9000914cd184b21d049581ace0d2a362507e7bd5383e452a7c30281f7afef18e374031c99dabcc49faeeec6e39de3c33ada443fbcd9fc
+  data.tar.gz: fd67b0330f582a5184da528433d284629c86ad1ca0e3cf0fe853e3cd7e927c258eb64b8a6f37f03c4ab7396437df7f96907b564ec7703cd74217f1846f344c9b

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2014 Monterail.com LLC
+
+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,67 @@
+# Grape::Sort [![Gem Version](https://badge.fury.io/rb/grape-order.png)]
+
+Collection ordering for [grape](https://github.com/intridea/grape) API framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-order'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install grape-order
+```
+
+## Usage
+
+```ruby
+class MyApi < Grape::API
+  # Include Grape::Sort module in your api
+  include Grape::Sort
+
+  resource :comments do
+    desc 'Return a list of comments.'
+
+    # Annotate action with `paginate`.
+    # This will add an optional param: order
+    #
+    # You can optionally set the default :order setting to the fields of your choice.
+    #
+    order '-created_at'
+
+    get do
+      comments = Comment.where(...)
+
+      # Use `order` helper to order the collection by passed params.
+      order(comments)
+    end
+
+  end
+end
+```
+
+Now you can pass a string `order` param to HTTP request to your endpoint structured as follows:
+
+- prepend field name by `-` to get ascending order, like `-created_at`
+- pass multiple fields to order by separating them by comma, like `-created_at, name`
+
+```
+curl -v http://lvh.me:3000/comments?order=-created_at
+```
+
+## Contributing
+
+The gem structure was based on https://github.com/monterail/grape-kaminari 
+(which can be used for pagination).
+
+Feel free to submit issue with bug report or pull requests on GitHub at https://github.com/PrositAS/grape-order.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+task default: :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/grape-order.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/order/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "grape-order"
+  spec.version       = Grape::Order::VERSION
+  spec.authors       = ["Grzegorz Brzezinka"]
+  spec.email         = ["greg@prosit.no"]
+  spec.description   = %q{collection ordering by params for grape API framework}
+  spec.summary       = %q{collection ordering for grape}
+  spec.homepage      = ""
+  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_runtime_dependency "grape"
+  spec.add_runtime_dependency "activerecord", "> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", "~> 2.9"
+end

data/lib/grape-order.rb

@@ -0,0 +1,11 @@
+module Grape
+  module Order
+    class << self
+      def post_0_9_0_grape?
+        Gem::Version.new(Grape::VERSION) > Gem::Version.new('0.9.0')
+      end
+    end
+  end
+end
+
+require "grape/order"

data/lib/grape/order.rb

@@ -0,0 +1,30 @@
+require "grape"
+require "grape/order/version"
+
+module Grape
+  module Order
+    def self.included(base)
+      base.class_eval do
+        helpers do
+          def order(collection)
+            sorters = params[:order].split(',').map do |s|
+              if s[0] == '-'
+                "#{s} asc"
+              else
+                "#{s} desc"
+              end
+            end
+            collection.order(sorters.join(','))
+          end
+        end
+
+        def self.order(sorter = nil)
+          params do
+            optional :order,     type: String, default: (sorter if sorter.present?),
+                     desc: 'Set sorting order.'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape/order/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Order
+    VERSION = "0.1.0"
+  end
+end

data/spec/order_helper_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'json'
+
+class Comment
+  include ActiveModel::Model
+
+  attr_accessor :id, :created_at
+end
+
+class CommentsCollection
+  def self.all
+    now = Time.now
+    1.upto(10).each do |i|
+      Comment.new(
+                 id: i,
+                 created_at: now + i.minutes
+      )
+    end
+    #TODO is there a way to test it without a db in test?
+  end
+end
+
+class OrderedAPI < Grape::API
+  include Grape::Order
+
+  order
+  get '' do
+    order(CommentsCollection.all)
+  end
+end
+
+describe Grape::Order do
+  subject { OrderedAPI.new }
+  def app; subject; end
+  let(:json) { JSON.parse(last_response.body) }
+
+  it 'orders by created_at asc' do
+    pending 'add db to tests'
+    get '/', order: 'created_at'
+    expect(json.pluck(:id)).to eq((1..10).to_a)
+  end
+
+
+end

data/spec/order_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'pry'
+
+class UnOrderedAPI < Grape::API
+  # Intentionally not including Grape::Order
+end
+
+class OrderedAPI < Grape::API
+  include Grape::Order
+end
+
+describe Grape::Order do
+
+  describe 'unordered api' do
+    subject { Class.new(UnOrderedAPI) }
+
+    it 'raises an error' do
+      expect { subject.order }.to raise_error(NoMethodError, /undefined method `order' for/i)
+    end
+  end
+
+  describe 'default ordered api' do
+    subject { Class.new(OrderedAPI) }
+
+    it 'adds to declared parameters' do
+      subject.order
+      if Grape::Order.post_0_9_0_grape?
+        expect(subject.inheritable_setting.route[:declared_params]).to eq([:order])
+      else
+        expect(subject.settings[:declared_params]).to eq([:order])
+      end
+    end
+
+    describe 'descriptions, validation, and defaults' do
+      before do
+        subject.order
+        subject.get '/' do; end
+      end
+      let(:params) {subject.routes.first.route_params}
+
+      it 'does not require :order' do
+        expect(params['order'][:required]).to eq(false)
+      end
+
+      it 'describes :order' do
+        expect(params['order'][:desc]).to eq('Set sorting order.')
+      end
+
+      it 'validates :order as String' do
+        expect(params['order'][:type]).to eq('String')
+      end
+
+      it 'defaults :order to nil' do
+        expect(params['order'][:default]).to eq(nil)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'grape'
+require 'grape-order'
+require 'active_record'
+require 'rack/test'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir['#{File.dirname(__FILE__)}/support/**/*.rb'].each {|f| require f}
+
+I18n.enforce_available_locales = false
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.order = 'random'
+  config.color = true
+  config.formatter = :documentation
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: grape-order
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Grzegorz Brzezinka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-25 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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rack-test
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: collection ordering by params for grape API framework
+email:
+- greg@prosit.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-order.gemspec
+- lib/grape-order.rb
+- lib/grape/order.rb
+- lib/grape/order/version.rb
+- spec/order_helper_spec.rb
+- spec/order_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.5.1
+signing_key: 
+specification_version: 4
+summary: collection ordering for grape
+test_files:
+- spec/order_helper_spec.rb
+- spec/order_spec.rb
+- spec/spec_helper.rb