wcc-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf529343f824edee3f097074da1f2c4595413736
+  data.tar.gz: 6ed98c0a62c3cd6b2f98f010a7d33b986584f24d
+SHA512:
+  metadata.gz: 46cc3b76fd6ef377a9875129ed64f99d7c3d3267b479067c57d7fb0aa95781173f2dd682bc57c8306430289e09fa77c1c81a0ce627370b040fe2d1582b4e42a6
+  data.tar.gz: de4678bb7d9236d184bfaa4e18c6c773de2e243cc627698bae7eecac9673584b432c47316646ee616be5162907670b43af900a14dab23cfe33153a207e0b47fd

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Travis Petticrew
+
+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,86 @@
+# WCC::API
+
+This library holds common code used in our applications that host APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wcc-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wcc-api
+
+## Usage
+
+### `WCC::API::BaseQuery`
+
+This provides an abstraction for building queries within an API for an
+ActiveRecord backed model. You must override the `default_scope` method
+to return a scope for the model you are querying on. The query object
+has the following:
+
+* `call` - calls each of the subsequent methods in order
+* `paged` - adds the paging elements to the query (e.g. limit and
+  offset)
+* `ordered` - hook to add ordering (default does nothing)
+* `filtered` - hook to add filtering (default does nothing)
+
+The Base implementation mostly just handles the paging and provides
+hooks to do other useful things. Here is an example implementation of a
+query object for a generic Tag model.
+
+```ruby
+class TagQuery < WCC::API::BaseQuery
+  def default_scope
+    Tag.all
+  end
+
+  def ordered(scope=self.scope)
+    scope.ordered
+  end
+
+  def filtered(scope=self.scope)
+    Array(filter[:name_like]).each do |query|
+      scope = scope.name_like(query)
+    end
+    scope
+  end
+end
+```
+
+### Pagination template
+
+To use the common pagination object template include the view helper in
+the controllers that will need it:
+
+```ruby
+class APIController < ApplicationController
+  helper WCC::API::ViewHelpers
+end
+```
+
+Now within your jbuilder templates you can do the following to include a
+Pagination object:
+
+```ruby
+json.pagination api_pagination_for(query: @query)
+```
+
+Where `@query` conforms to the interface specified by
+`WCC::API::BaseQuery`.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/wcc-api/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/wcc/api/base_query.rb

@@ -0,0 +1,83 @@
+module WCC::API
+  class BaseQuery
+    attr_reader :scope
+    attr_accessor :limit, :offset
+    attr_accessor :filter
+
+    MAX_LIMIT = 50
+
+    def default
+      {
+        limit: 20,
+        offset: 0,
+        filter: {}
+      }
+    end
+
+    def permitted_keys
+      %i(limit offset filter)
+    end
+
+    def default_scope
+      raise NotImplementedError
+    end
+
+    def initialize(params, scope: default_scope)
+      @scope = scope
+      set_defaults
+      permitted_keys.each do |key|
+        self.public_send("#{key}=", params[key]) if params.has_key?(key)
+      end
+    end
+
+    def call(scope=self.scope)
+      scope = scope.dup
+      scope = paged(scope)
+      scope = ordered(scope)
+      scope = filtered(scope)
+      scope
+    end
+
+    def paged(scope=self.scope)
+      scope
+        .limit(limit)
+        .offset(offset)
+    end
+
+    def ordered(scope=self.scope)
+      scope
+    end
+
+    def filtered(scope=self.scope)
+      scope
+    end
+
+    def set_defaults
+      default.each do |key, value|
+        public_send("#{key}=", value)
+      end
+    end
+
+    def limit=(new_limit)
+      new_limit = new_limit.to_i
+      @limit = (new_limit > MAX_LIMIT) ? MAX_LIMIT : new_limit
+    end
+
+    def offset=(new_offset)
+      @offset = new_offset.to_i
+    end
+
+    def total
+      @total ||= filtered.count
+    end
+
+    def size
+      if total - offset < limit
+        total - offset
+      else
+        limit
+      end
+    end
+  end
+end
+

data/lib/wcc/api/json/pagination.rb

@@ -0,0 +1,53 @@
+module WCC::API::JSON
+  class Pagination
+    attr_reader :query, :url_for
+
+    def initialize(query, url_for:)
+      @query = query
+      @url_for = url_for
+    end
+
+    def to_builder
+      Jbuilder.new do |json|
+        json.total query.total
+        json.size query.size
+        json.limit query.limit
+        json.offset query.offset
+        json.order_by query.order_by if query.respond_to?(:order_by)
+        json.sort query.sort if query.respond_to?(:sort)
+        json.filter query.filter
+        json._links do
+          json.self url_for.(base_url_params)
+          if has_previous_page?
+            json.previous url_for.(base_url_params.merge(offset: query.offset - query.limit))
+          end
+          if has_next_page?
+            json.next url_for.(base_url_params.merge(offset: query.offset + query.limit))
+          end
+        end
+      end
+    end
+
+    private
+
+    def has_previous_page?
+      query.offset - query.limit >= 0
+    end
+
+    def has_next_page?
+      query.offset + query.limit < query.total
+    end
+
+    def base_url_params
+      @base_url_params ||= {
+        limit: query.limit,
+        offset: query.offset,
+        filter: query.filter,
+        only_path: false
+      }.tap do |params|
+        params[:order_by] = query.order_by if query.respond_to?(:order_by)
+        params[:sort] = query.sort if query.respond_to?(:sort)
+      end
+    end
+  end
+end

data/lib/wcc/api/json.rb

@@ -0,0 +1,6 @@
+module WCC::API
+  module JSON
+  end
+end
+
+require 'wcc/api/json/pagination'

data/lib/wcc/api/railtie.rb

@@ -0,0 +1,13 @@
+require 'wcc/api'
+
+module WCC
+  module API
+    class Railtie < Rails::Railtie
+      initializer 'wcc.api railtie initializer', group: :all do |app|
+        ActiveSupport::Inflector.inflections(:en) do |inflect|
+          inflect.acronym 'API'
+        end
+      end
+    end
+  end
+end

data/lib/wcc/api/rspec/pagination_examples.rb

@@ -0,0 +1,39 @@
+RSpec.shared_examples_for :linked_pagination_object do |url_method, base_options, total|
+  it "includes link to current page" do
+    url = public_send(
+      url_method,
+      base_options.merge(limit: 2, offset: 2)
+    )
+    get url
+    expect(subject['_links']).to be_a(Hash)
+    expect(subject['_links']['self']).to eq(url)
+  end
+
+  it "includes link to next page when there is a next page" do
+    get public_send(url_method, limit: 2)
+    url = public_send(url_method,
+      base_options.merge(limit: 2, offset: 2)
+    )
+    expect(subject['_links']['next']).to eq(url)
+  end
+
+  it "does not include link to next page when this is the last page" do
+    get public_send(url_method, limit: 2, offset: total - 1)
+    expect(subject['_links']['next']).to be_nil
+  end
+
+  it "includes link to previous page when there is a previous page" do
+    get public_send(url_method, limit: 2, offset: 2)
+    url = public_send(
+      url_method,
+      base_options.merge(limit: 2, offset: 0)
+    )
+    expect(subject['_links']['previous']).to eq(url)
+  end
+
+  it "does not include link to next page when this is the last page" do
+    get public_send(url_method, limit: 2)
+    expect(subject['_links']['previous']).to be_nil
+  end
+end
+

data/lib/wcc/api/version.rb

@@ -0,0 +1,5 @@
+module WCC
+  module API
+    VERSION = "0.0.1"
+  end
+end

data/lib/wcc/api/view_helpers.rb

@@ -0,0 +1,12 @@
+module WCC::API
+  module ViewHelpers
+
+    def api_pagination_for(query:)
+      WCC::API::JSON::Pagination.new(
+        query,
+        url_for: -> (params) { url_for(params) }
+      ).to_builder
+    end
+
+  end
+end

data/lib/wcc/api.rb

@@ -0,0 +1,17 @@
+require 'wcc'
+require 'wcc/api/version'
+
+module WCC
+  module API
+    PROJECT_ROOT = File.expand_path(File.join(__FILE__, '..', '..', '..'))
+  end
+end
+
+if defined?(Rails)
+  require 'wcc/api/railtie'
+end
+
+require 'wcc/api/base_query'
+require 'wcc/api/json'
+require 'wcc/api/view_helpers'
+

data/wcc-api.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wcc/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wcc-api"
+  spec.version       = WCC::API::VERSION
+  spec.authors       = ["Watermark Dev Team"]
+  spec.email         = ["dev@watermark.org"]
+  spec.summary       = %q{Holds common code used in our applications that host APIs.}
+  spec.description   = %q{holds common code used in our applications that host APIs.}
+  spec.homepage      = "https://github.com/watermarkchurch/wcc-api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "wcc-base"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: wcc-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Watermark Dev Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wcc-base
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: holds common code used in our applications that host APIs.
+email:
+- dev@watermark.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wcc/api.rb
+- lib/wcc/api/base_query.rb
+- lib/wcc/api/json.rb
+- lib/wcc/api/json/pagination.rb
+- lib/wcc/api/railtie.rb
+- lib/wcc/api/rspec/pagination_examples.rb
+- lib/wcc/api/version.rb
+- lib/wcc/api/view_helpers.rb
+- wcc-api.gemspec
+homepage: https://github.com/watermarkchurch/wcc-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.4.2
+signing_key: 
+specification_version: 4
+summary: Holds common code used in our applications that host APIs.
+test_files: []