api_recipes 0.7.0 → 2.6.1

data/CHANGELOG.md

@@ -1,15 +0,0 @@
-## Version 0.6.0 - Default to HTTPS
-
-**POSSIBLE BREAKING CHANGES**
-
-Requests now default to HTTPS. If you still want to use (unsecure) HTTP you have to specify it in your configs through the dedicated `protocol` option e.g.
-
-```yaml
-github:
-  protocol: http
-  host: api.github.com
-```
-
-## Version 0.5.0 - Better Exceptions
-
-Exceptions now include attributes that can be accessed during the `rescue` phase in order to execute specific actions

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# 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/Gemfile

@@ -1,12 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'rake', '~> 12.3'
-
-group :test do
-  gem 'rspec', '~> 3.8.0'
-  gem 'guard',          '~> 2.15.0'
-  gem 'guard-rspec',    '~> 4.7.3'
-  gem 'guard-bundler',  '~> 2.2.1'
-end

data/Guardfile

@@ -1,14 +0,0 @@
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
-  dsl = Guard::RSpec::Dsl.new(self)
-
-  # RSpec files
-  rspec = dsl.rspec
-  watch(rspec.spec_helper) { rspec.spec_dir }
-  watch(rspec.spec_support) { rspec.spec_dir }
-  watch(rspec.spec_files)
-
-  # Ruby files
-  ruby = dsl.ruby
-  dsl.watch_spec_files_for(ruby.lib_files)
-end

data/Rakefile

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

data/api_recipes.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'api_recipes/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'api_recipes'
-  spec.version       = ApiRecipes::VERSION
-  spec.authors       = ['Alessandro Verlato']
-  spec.email         = ['averlato@gmail.com']
-
-  spec.summary       = %q{Consume HTTP APIs with style}
-  spec.homepage      = 'https://github.com/madAle/api_recipes'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.required_ruby_version = '> 2.2.0'
-
-  spec.add_dependency 'oj', '~> 3.7.0'
-  spec.add_dependency 'http', '~> 4.1.1'
-end

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "api_recipes"
-
-# 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

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/examples/authorization.rb

@@ -1,42 +0,0 @@
-require 'api_recipes'
-require 'yaml'
-
-# Configure RemoteApi through a yaml file.
-# Take a look at examples/config/apis.yml  for details
-ApiRecipes.configure do |config|
-  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
-end
-
-# Let's create a simple class that uses ApiRecipes
-class MyFancyClass
-  include ApiRecipes
-
-  # Declare the endpoints that we're going to use
-  endpoint :github
-end
-
-# Setup Auth. This will set/replace the HTTP 'Authorization' header with the
-# provided value
-
-# Get your OAUTH token on Github.
-# Navigate Profile => Settings => Personal Access Tokens => Generate new token
-# Copy the generated string and substitute it to YOUR_GITHUB_OAUTH_TOKEN below
-MyFancyClass.github.authorization = 'token YOUR_GITHUB_OAUTH_TOKEN'
-
-MyFancyClass.github.users.list do |users|
-  puts users.collect{ |user| user['login'] }
-end
-
-# From now on every MyFancyClass (and its instances) github's api request will
-# be authenticated through the provided auth
-
-# Get user's usernames from Github's Apis (https://github.com)
-usernames = nil
-MyFancyClass.github.users.list do |users|
-  usernames = users.collect{ |user| user['login'] }
-end
-
-# Get user's repos
-MyFancyClass.github.users.repos(user_id: usernames.first) do |repos|
-  puts repos
-end

data/examples/authorization_with_default_headers.rb

@@ -1,41 +0,0 @@
-require 'api_recipes'
-require 'yaml'
-
-# Configure RemoteApi through a yaml file.
-# Take a look at examples/config/apis.yml  for details
-ApiRecipes.configure do |config|
-  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
-end
-
-# Let's create a simple class that uses ApiRecipes
-class MyFancyClass
-  include ApiRecipes
-
-  # Get your OAUTH token on Github.
-  # Navigate Profile => Settings => Personal Access Tokens => Generate new token
-  # Copy the generated string and substitute it to YOUR_GITHUB_OAUTH_TOKEN below
-
-  MY_CUSTOM_CONFIG = {
-      default_headers: {
-          'Authorization' => 'token YOUR_GITHUB_OAUTH_TOKEN'
-      }
-  }
-
-  # Declare the endpoints that we're going to use
-  # Add some custom configs
-  endpoint :github, MY_CUSTOM_CONFIG
-end
-
-# From now on every MyFancyClass (and its instances) github's api request will
-# be authenticated through the provided Authorization header
-
-# Get user's usernames from Github's Apis (https://github.com)
-usernames = nil
-MyFancyClass.github.users.list do |users|
-  usernames = users.collect{ |user| user['login'] }
-end
-
-# Get user's repos
-MyFancyClass.github.users.repos(user_id: usernames.first) do |repos|
-  puts repos
-end

data/examples/basic_auth.rb

@@ -1,32 +0,0 @@
-require 'api_recipes'
-require 'yaml'
-
-# Configure RemoteApi through a yaml file.
-# Take a look at examples/config/apis.yml  for details
-ApiRecipes.configure do |config|
-  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
-end
-
-# Let's create a simple class that uses ApiRecipes
-class MyFancyClass
-  include ApiRecipes
-
-  # Declare the endpoints that we're going to use
-  endpoint :github
-end
-
-# Setup Basic Auth
-MyFancyClass.github.basic_auth = { user: 'github_username', pass: 'github_password' }
-
-# From now on every github's api request will be authenticated with basic auth
-
-# Get user's usernames from Github's Apis (https://github.com)
-usernames = nil
-MyFancyClass.github.users.list do |users|
-  usernames = users.collect{ |user| user['login'] }
-end
-
-# Get user's repos
-MyFancyClass.github.users.repos(user_id: usernames.first) do |repos|
-  puts repos
-end

data/examples/config/apis.yml

@@ -1,43 +0,0 @@
-github:
-  protocol: https           # Optional, defaults to: 'https'
-  host: api.github.com      # Optional, defaults to: 'localhost'
-  port: 443                 # Optional, defaults to: 80 for http and 443 for https
-  base_path:                # Optional, defaults to: ''
-  api_version:              # Optional, defaults to: ''
-  timeout: 3                # Optional, defaults to: 3 (time expressed in seconds)
-  on_nok_code: :raise       # Optional, defaults to :raise. Possible values: [:do_nothing, :raise, :return_false]
-  default_headers:
-    accept: 'application/vnd.github.v3+json'
-    content_type: 'application/json'
-
-  routes:
-    users:
-      list:
-        path:               # Optional, defaults to: ''
-        method: get         # Optional, defaults to: get
-        ok_code: 200        # Optional, defaults to: 200
-
-      show:
-        path: /:user_id     # You can use :some_param notation and provide the param when calling the route (see examples/simple.rb)
-
-      repos:
-        path: /:user_id/repos
-
-
-# Example of test endpoint with minimal configuration and multiple routes
-jsonplaceholder:
-  host: jsonplaceholder.typicode.com
-
-  routes:
-    users:
-      list:
-      show:
-        path: /:user_id     # You can use :some_param notation and provide params when calling the route (see examples/simple.rb)
-
-    posts:
-      list:
-      show:
-        path: /:post_id
-
-      comments:
-        path: /:post_id/comments

data/examples/custom_configs.rb

@@ -1,51 +0,0 @@
-# This example aims to demonstrate how to provide custom configs to endpoints
-
-require 'api_recipes'
-
-# Configure RemoteApi through custom settings
-FAKE_API_SETTINGS = {
-    host: 'jsonplaceholder.typicode.com',
-    timeout: 10,
-    routes: {
-        users: {
-            list: nil,
-            show: {
-                path: '/:user_id'
-            }
-        },
-        posts: {
-            list: nil,
-            comments: {
-                path: '/:post_id/comments'
-            }
-        }
-    }
-}
-
-# Let's create a simple class that uses ApiRecipes
-class MyFancyClass
-  include ApiRecipes
-
-  # Declare the endpoints that we're going to use
-  endpoint :fake_api, FAKE_API_SETTINGS
-end
-
-# Let's demonstrate that even a class instance can use enpoints
-fancy_instance = MyFancyClass.new
-
-# Get User's names
-fancy_instance.fake_api.users.list do |users|
-  names = users.collect{ |user| user['name'] }
-  puts "Names: #{names}"
-end
-
-# Collect post ids
-post_ids = nil
-MyFancyClass.fake_api.posts.list do |posts|
-  post_ids = posts.map{ |post| post['id'] }
-end
-
-# Fetch post's comments
-fancy_instance.fake_api.posts.comments(post_id: post_ids.last) do |comments|
-  puts "Comments: #{comments}"
-end

data/examples/delete_me.rb

@@ -1,21 +0,0 @@
-require 'api_recipes'
-require 'yaml'
-
-ApiRecipes.configure do |config|
-  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
-end
-
-class Foo
-  include ApiRecipes
-
-  endpoint :jsonplaceholder
-end
-
-puts 'Use from class:'
-puts Foo.jsonplaceholder.users.list
-
-f1 = Foo.new
-
-puts "\n\nUse from instance:"
-sleep 1
-puts f1.jsonplaceholder.users.list

data/examples/multiple_endpoints.rb

@@ -1,54 +0,0 @@
-require 'api_recipes'
-require 'yaml'
-
-# Configure RemoteApi through a yaml file.
-# Take a look at examples/config/apis.yml  for details
-ApiRecipes.configure do |config|
-  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
-end
-
-# Let's create a simple class that uses ApiRecipes
-class MyFancyClass
-  include ApiRecipes
-
-  # Declare the endpoints that we're going to use
-  endpoint :jsonplaceholder
-  endpoint :github
-end
-
-# Get users from JSONPlaceholder (http://jsonplaceholder.typicode.com/users)
-MyFancyClass.jsonplaceholder.users.list do |users|
-  puts 'Usernames:'
-  puts users.collect{ |user| user['name'] }
-end
-
-# Get posts from JSONPlaceholder (http://jsonplaceholder.typicode.com/posts)
-post_ids = nil
-MyFancyClass.jsonplaceholder.posts.list do |posts|
-  post_ids = posts.map{ |post| post['id'] }
-end
-
-puts "\n\n\n\n"
-# Get first post's comments from JSONPlaceholder
-# http://jsonplaceholder.typicode.com/posts/1/comments
-MyFancyClass.jsonplaceholder.posts.comments(post_id: post_ids.first) do |comments|
-  puts "Comments:"
-  puts comments
-end
-
-puts "\n\n\n\n"
-# Get also Github users
-# Warning: Github has a low rate limit for unauthorized api requests.
-MyFancyClass.github.users.list do |body, status_code, status_message|
-  puts "Response: #{status_code}: #{status_message}"
-  puts "Data: #{body}"
-end
-
-# If you need a 'raw' response (e.g. the response must not automatically be
-# parsed as JSON) just don't provide a block and the result will be an
-# HTTP::Response object. See https://github.com/httprb/http for further details
-
-response = MyFancyClass.github.users.list
-puts response.code    # e.g. 200
-puts response.reason  # e.g. OK
-puts response.body    # e.g  Some response body (not necessarely JSON)

data/examples/simple_usage.rb

@@ -1,38 +0,0 @@
-require 'api_recipes'
-require 'yaml'
-
-# Configure RemoteApi through a yaml file.
-# Take a look at examples/config/apis.yml  for details
-ApiRecipes.configure do |config|
-  config.endpoints_configs = YAML.load_file(File.expand_path('examples/config/apis.yml'))
-end
-
-# Let's create a simple class that uses ApiRecipes
-class MyFancyClass
-  include ApiRecipes
-
-  endpoint :github
-end
-
-
-# Warning: Github has a low rate limit for unauthorized api requests.
-
-
-# Get user's usernames from Github's Apis (https://github.com)
-usernames = nil
-
-MyFancyClass.github.users.list do |users|
-  usernames = users.collect{ |user| user['login'] }
-end
-
-# Get user's repos
-MyFancyClass.github.users.repos(user_id: usernames.first) do |repos|
-  puts repos
-end
-
-# The endpoints are available on instances too
-fancy = MyFancyClass.new
-
-fancy.github.users.list do |users|
-  puts users.collect{ |user| user['login'] }
-end