ruby-apicalypse 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 302530da949aa573fdd0ff2de172205b9cef45554795eeeba39e763a5472692b
+  data.tar.gz: 7a3225d1776a3e4074f434718c1664473477ab7cac1b7c648b887807e08c6ad5
+SHA512:
+  metadata.gz: d35a4165dd080b17059dea7a29b5fb887a11459282a7e8eeb9df186380360bb6cea1acee48a44df38237a6e5492ac1626beaef75f7dffc136ae7409f056b17f4
+  data.tar.gz: e910b48a66e5d85a02db77ec844cdf4c9b2a2fd4f246b04eb37ee577bcb101cd2e9930fce31098ed74fc1aefb921dbc5c1634a460ed749051e7516a75e0ff6d1

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    ruby-apicalypse (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    hashdiff (0.3.8)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  ruby-apicalypse!
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019
+
+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,123 @@
+# Ruby wrapper for Apicalypse
+
+[What is Apicalypse?](https://apicalypse.io/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-apicalypse'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-apicalypse
+
+## Usage
+
+### Raw Apicalypse
+
+```ruby
+rawQueryString = "fields a,b,c;limit 50;offset 0;";
+
+Apicalypse.new("https://myapi.com/foobar")
+  .query(rawQueryString)
+  .request
+```
+
+### Apicalypse Query Builder
+
+```ruby
+api = Apicalypse.new("https://myapi.com/foobar")
+
+api
+  .fields(:name, :movies, :age) # fetches only the name, movies and age fields
+  .limit(50) # limit to 50 results
+  .offset(10) # offset results by 10
+  .sort(:name) # default sort direction is 'asc' (ascending)
+  .sort(:name, :desc) # sorts by name, descending
+  .search("Arnold") # search for a specific name (search implementations can vary)
+  .where("age > 50 & movies != n") # filter the results
+
+api.request
+```
+
+Learn more about the Apicalypse syntax [here](https://apicalypse.io/syntax/).
+
+### Optional configurations
+
+By default, the apicalypse query method is put in the request body. If your server doesn't support GET bodies, you can put the request in the URL as instead.
+
+```ruby
+# Raw
+Apicalypse.new("https://any-apicalypse-api.com/foobar", {
+  queryMethod: :url
+})
+  .query("limit=50&fields=name")
+  .request
+
+# Scoped
+Apicalypse.new("https://any-apicalypse-api.com/foobar", {
+  queryMethod: :url
+})
+  .limit(50)
+  .fields(:name)
+  .request
+```
+
+Both examples will request `https://any-apicalypse-api.com/foobar?limit=50&fields=name`.
+
+You can also pass custom request headers.
+
+```ruby
+Apicalypse.new("https://any-apicalypse-api.com/foobar", {
+  headers: {
+    'user-key' => 'your-api-key',
+    'Accept'   => 'application/json'
+  }
+})
+  .search('Json Born')
+  .request
+```
+
+### Real world example
+
+```ruby
+api_endpoint = 'https://api-v3.igdb.com/games'
+request_headers = { headers: { 'user-key' => 'your-igdb-api-key' } }
+
+api = Apicalypse.new(api_endpoint, request_headers)
+
+api
+  .fields(:name, :total_rating)
+  .where(category: 1)
+  .search('Call of Duty')
+  .limit(2)
+  .request
+
+# api response
+
+[
+  {"id"=>107299, "name"=>"Call of Duty: WWII - Shadow War", "total_rating"=>75.0},
+  {"id"=>57700, "name"=>"Call of Duty: Infinite Warfare - Retribution", "total_rating"=>60.0}
+]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/ad2games/ruby-apicalypse. 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](https://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'apicalypse'
+
+# 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(__FILE__)

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/apicalypse.rb

@@ -0,0 +1,49 @@
+require 'apicalypse/exceptions'
+require 'apicalypse/request'
+require 'apicalypse/scope'
+require 'apicalypse/version'
+
+class Apicalypse
+  def initialize(uri, options = {})
+    @scope = Scope.new(self)
+    @request = Request.new(uri, options)
+  end
+
+  attr_reader :scope
+
+  def fields(*args)
+    @scope.fields(args)
+  end
+
+  def exclude(args)
+    @scope.exclude(args)
+  end
+
+  def where(args)
+    @scope.where(args)
+  end
+
+  def limit(args)
+    @scope.limit(args)
+  end
+
+  def offset(args)
+    @scope.offset(args)
+  end
+
+  def sort(args)
+    @scope.sort(args)
+  end
+
+  def search(args)
+    @scope.search(args)
+  end
+
+  def query(args)
+    @scope.query(args)
+  end
+
+  def request
+    @request.perform(@scope)
+  end
+end

data/lib/apicalypse/exceptions.rb

@@ -0,0 +1,3 @@
+class Apicalypse
+  class ScopeError < StandardError; end
+end

data/lib/apicalypse/request.rb

@@ -0,0 +1,75 @@
+require 'net/http'
+require 'json'
+
+class Apicalypse
+  class Request
+    def initialize(uri, options)
+      @uri = uri
+      @options = options
+    end
+
+    def perform(scope)
+      uri = build_uri(scope)
+      body = build_body(scope)
+
+      response = http_get(uri, body)
+      raise_on_http_error(response)
+
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def build_uri(scope)
+      uri = URI(@uri)
+
+      return uri unless query_method_url?
+
+      uri.query = if scope.chain[:query]
+                    scope.chain[:query]
+                  else
+                    scope.chain.to_query
+                  end
+
+      uri
+    end
+
+    def build_body(scope)
+      return scope.chain[:query] if scope.chain[:query]
+
+      scope.chain.map do |k, v|
+        if v.is_a?(Hash)
+          "#{k} #{v.keys[0]}=#{v.values[0]};"
+        else
+          "#{k} #{v};"
+        end
+      end.join('')
+    end
+
+    def http_get(uri, body)
+      Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+        req = Net::HTTP::Get.new(uri, request_headers)
+        req.body = body unless query_method_url?
+
+        http.request req
+      end
+    end
+
+    def request_headers
+      headers = { 'Accept' => 'application/json' }
+      headers.merge!(@options[:headers]) if @options[:headers]
+
+      headers
+    end
+
+    def raise_on_http_error(response)
+      return if response.is_a? Net::HTTPSuccess
+
+      raise "Request failed with status #{response.code}: #{response.body}"
+    end
+
+    def query_method_url?
+      @options[:query_method] == :url
+    end
+  end
+end

data/lib/apicalypse/scope.rb

@@ -0,0 +1,66 @@
+class Apicalypse
+  class Scope
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def chain
+      @chain ||= {}
+    end
+
+    def fields(*args)
+      chain[:fields] = args.join(',')
+      @klass
+    end
+
+    def exclude(*args)
+      chain[:exclude] = args.join(',')
+      @klass
+    end
+
+    def where(args)
+      raise_on_invalid_scope_chain(args)
+
+      chain[:where] = chain[:where] ? chain[:where].merge!(args) : args
+      @klass
+    end
+
+    def limit(args)
+      chain[:limit] = args
+      @klass
+    end
+
+    def offset(args)
+      chain[:offset] = args
+      @klass
+    end
+
+    def sort(args)
+      chain[:sort] = args
+      @klass
+    end
+
+    def search(args)
+      chain[:search] = format('"%<term>s"', term: args)
+      @klass
+    end
+
+    def query(args)
+      chain[:query] = args
+      @klass
+    end
+
+    private
+
+    def raise_on_invalid_scope_chain(scope)
+      return unless chain[:where]
+
+      if chain[:where].class != scope.class
+        raise ScopeError, /Hash and String where scopes can't be combined./
+      end
+      if chain[:where].is_a?(String)
+        raise ScopeError, /Multiple String where scopes are not supported./
+      end
+    end
+  end
+end

data/lib/apicalypse/version.rb

@@ -0,0 +1,3 @@
+class Apicalypse
+  VERSION = '0.1.0'.freeze
+end

data/ruby-apicalypse.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apicalypse/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruby-apicalypse'
+  spec.version       = Apicalypse::VERSION
+  spec.authors       = ['Stefan Greffenius']
+  spec.email         = ['stefan.greffenius@gmail.com']
+
+  spec.summary       = 'Ruby wrapper gem for creating simple Apicalypse queries.'
+  spec.description   = 'More informations related to Apicalypse can be found here: https://apicalypse.io/'
+  spec.homepage      = 'https://www.github.com/ad2games/ruby-apicalypse'
+  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'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ruby-apicalypse
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Greffenius
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'More informations related to Apicalypse can be found here: https://apicalypse.io/'
+email:
+- stefan.greffenius@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/apicalypse.rb
+- lib/apicalypse/exceptions.rb
+- lib/apicalypse/request.rb
+- lib/apicalypse/scope.rb
+- lib/apicalypse/version.rb
+- ruby-apicalypse.gemspec
+homepage: https://www.github.com/ad2games/ruby-apicalypse
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper gem for creating simple Apicalypse queries.
+test_files: []