api_monkey 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14630a35b125ccf8d2107cb54a0d4be4f16d8031
+  data.tar.gz: e7fd94d3f82f6c99b4eba34f769422f1cba993e4
+SHA512:
+  metadata.gz: db3fdc5d3e2a09e81a6fcafd0bfdbfa70e9fa884a728b3709c0a3ef96320c63e26f6e29edace93dd46b9a432eddfcf790d44adbb6d48c2e27f5256b1ce5271be
+  data.tar.gz: 018ded42e99d237e7ff8cc40b239c7849f3dd28eae26cf88d84ab43caf051b161de50e58bdeaa1c32d7cc477554fd647938167462b2105214b315afd228541ab

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/CONTRIBUTE.md

@@ -0,0 +1,88 @@
+# CONTRIBUTE
+
+This is the contribute.md of our project. Great to have you here. Here
+are a few ways you can help make this project better!
+
+## Adding new features
+
+This section includes advice on how to build new features for the
+project & what kind of process it includes.
+
+* This is how we like people to add new features:
+* Here are some specifics on the coding style we prefer:
+* This is how you send your pull request:
+* You should include the following tests:
+
+# Bug triage
+
+This sections explains how bug triaging is done for your project. Help
+beginners by including examples to good bug reports and providing them
+questions they should look to answer.
+
+* You can help report bugs by filing them here:
+* You can look through the existing bugs here:
+
+* You can help us diagnose and fix existing bugs by asking and providing
+  answers for the following:
+
+  * Is the bug reproducible as explained?
+  * Is it reproducible in other environments (for instance, on different
+    browsers or devices)?
+  * Are the steps to reproduce the bug clear? If not, can you describe
+    how you might reproduce it?
+  * What tags should the bug have?
+  * Is this bug something you have run into? Would you appreciate it
+    being looked into faster?
+
+* You can close fixed bugs by testing old tickets to see if they are
+  still happening.
+* You can update our changelog here:
+* You can remove duplicate bug reports by:
+
+
+# Beta testing
+
+This section explains if your project needs beta testing. Explain why
+early releases require heavy testing and how they can help with
+specially across browsers and on different hardware.
+
+* For our project you can find the roadmap and features that require
+testing from here:
+
+# Translations
+
+This section includes any instructions or translation needs your project
+has.
+
+* You can help us translate our project here:
+
+# Documentation
+
+This section includes any help you need with the documentation and where
+it can be found. Code needs explanation, and sometimes those who know
+the code well have trouble explaining it to someone just getting into
+it.
+
+* Help us with documentation here
+
+# Community
+This section includes ideas on how non-developers can help with the
+project. Here's a few examples:
+
+* You can help us answer questions our users have here:
+* You can help build and design our website here:
+* You can help write blog posts about the project by:
+* You can help with newsletters and internal communications by:
+
+* Create an example of the project in real world by building something
+  or
+showing what others have built.
+* Write about other people’s projects based on this project. Show how
+it’s used in daily life. Take screenshots and make videos!
+
+
+# Your first bugfix
+This section should help a person get started with their very first bug
+fix and thinking through the problem.
+
+* If you have further questions, contact:

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Kelly
+
+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,62 @@
+# ApiMonkey
+Makes building data-driven APIs in Rails a breeze by providing an easy to use DSL for declaring API resources.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_monkey'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+Once you have ApiMonkey installed, declare your model as an ApiMonkey model:
+
+```ruby
+# app/models/product.rb
+
+class Product < ActiveRecord::Base
+  include ApiMonkey
+end
+```
+
+### Filter Params
+Filter params provide a clean and easy way to add request-based
+filtering of your active record models:
+
+```ruby
+# app/controllers/products_controller.rb
+
+class ProductsController < ApplicationController
+  def index
+    @products = Product.filter(filter_params)
+  end
+
+  protected
+
+  def filter_params
+    params.slice(:active, :price, :code)
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. 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/michaelkelly322/api_resource. Guidelines and suggestion can be found in our [CONTRIBUTE.md file](https://github.com/michaelkelly322/api_monkey/blob/master/CONTRIBUTE.md). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/api_monkey.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_monkey/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_monkey"
+  spec.version       = ApiMonkey::VERSION
+  spec.authors       = ["Michael Kelly"]
+  spec.email         = ["michaelkelly322@gmail.com"]
+
+  spec.summary       = "Makes building data-driven APIs in Rails a breeze"
+  spec.description   = "Makes building data-driven APIs in Rails a breeze by providing an easy to use DSL for declaring API resources"
+  spec.homepage      = "https://github.com/michaelkelly322/api_monkey"
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_resource"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api_monkey/filter_scopes.rb

@@ -0,0 +1,11 @@
+module ApiMonkey::FilterScopes
+  extend ActiveSupport::Concern
+
+  included do
+    column_names.map do |field_name|
+      define_singleton_method "filter_#{field_name}" do |param|
+        where("#{field_name} = ?", param)
+      end
+    end
+  end
+end

data/lib/api_monkey/filterable.rb

@@ -0,0 +1,14 @@
+module ApiMonkey::Filterable
+  extend ActiveSupport::Concern
+
+  included do
+    define_singleton_method :filter do |filtering_params|
+      results = self.where(nil)
+      filtering_params.each do |key, value|
+        results = results.public_send("filter_#{key}", value) if value.present?
+      end
+      results
+    end
+  end
+end
+

data/lib/api_monkey/version.rb

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

data/lib/api_monkey.rb

@@ -0,0 +1,9 @@
+require "api_monkey/version"
+require "api_monkey/filterable"
+require "api_monkey/filter_scopes"
+
+module ApiMonkey
+  extend ActiveSupport::Concern
+  include ApiMonkey::Filterable
+  include ApiMonkey::FilterScopes
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: api_monkey
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michael Kelly
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Makes building data-driven APIs in Rails a breeze by providing an easy
+  to use DSL for declaring API resources
+email:
+- michaelkelly322@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTE.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_monkey.gemspec
+- bin/console
+- bin/setup
+- lib/api_monkey.rb
+- lib/api_monkey/filter_scopes.rb
+- lib/api_monkey/filterable.rb
+- lib/api_monkey/version.rb
+homepage: https://github.com/michaelkelly322/api_monkey
+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.6
+signing_key: 
+specification_version: 4
+summary: Makes building data-driven APIs in Rails a breeze
+test_files: []