external_api_service 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8a6d1ed464dd884eb7ecec6f783d78521006391
+  data.tar.gz: 12c9a87d3e9d9740133cddadb0e7cbe7c94def6d
+SHA512:
+  metadata.gz: 00b068a699b4a932442f4b7a1e93760420235e2a05402c1cad9a2e7e41297b40cfc08d4a79357d81e0622ca0a6b620c9aef6dc6be6de44cba862a523062248a6
+  data.tar.gz: abe663289c6bf5ad6d8f4926a486a9c03a971987a495a599a2a7432a54fe46b2c751ff816f4e061d010d3203f2ff1f190c70d1ff271d8495d981625dfe369631

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,17 @@
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler
+
+language: ruby
+rvm:
+  - 2.2.0
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - nick.rakochy@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/README.md

@@ -0,0 +1,61 @@
+[![Build Status](https://travis-ci.org/nrakochy/external_api_service.svg?branch=master)](https://travis-ci.org/nrakochy/external_api_service.svg?branch=master)
+[![Coverage Status](https://coveralls.io/repos/nrakochy/external_api_service/badge.svg?branch=master)](https://coveralls.io/r/nrakochy/external_api_service?branch=master)
+[![Gem Version](https://badge.fury.io/rb/external_api_service.svg)](http://badge.fury.io/rb/external_api_service)
+
+# ExternalApiService
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'external_api_service'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install external_api_service
+
+## Usage
+To use, you need to require the service module wherever you are wanting to use it:
+
+    require ‘ExternalApiService’
+
+To make a GET request, you need an endpoint (required), and any query params in a Hash (optional). The endpoint must return `JSON`.
+It will work with `HTTPS` or `HTTP`. Call `get_service`:
+
+    # no params
+    url = “https://data.cityofchicago.org/Buildings/Problem-Landlord-List-Map/dip3-ud6z”
+    ExternalApiService.get_service(url)
+
+    # with params
+    url = “https://my.endpoint/path”
+    params = { sample_category: “sample_category_name” }
+    ExternalApiService.get_service(url, params)
+
+`get_service` will transform the JSON to Ruby Hash with symbolized names:
+
+    # First entry from the Chicago Problem Landlord List in Array of Hashes (“https://data.cityofchicago.org/Buildings/Problem-Landlord-List-Map/dip3-ud6z”)
+
+    [{:respondent=>”Ravine Properties, LLC”, :secondary_address=>”5849 W ARTHINGTON ST”,
+    :location=>{:needs_recoding=>false, :longitude=>”-87.7716557532”, :latitude=>”41.8690630014”},
+    :census_tracts=>”17031831400”, :census_blocks=>”170318314002042”, :x_coordinate=>”1137233.9789750562”,
+    :street_block_id=>”7445”, :ward=>”29”, :address=>”1001 S MAYFIELD AVE”, :y_coordinate=>”1895377.068646989”,
+    :community_area=>”AUSTIN”, :longitude=>”-87.7716557532”, :latitude=>”41.8690630014”, :community_area_number=>”25”}]
+
+## Features To-Do
+Does not support `JSONP`.
+
+Only makes GET requests. Probably need to update to make POST requests as well.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/external_api_service/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,13 @@
+begin
+  require 'rspec/core/rake_task'
+  require 'bundler/gem_tasks'
+  require 'coveralls/rake/task'
+
+  Coveralls::RakeTask.new
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.rspec_opts = ['--color', '--format documentation']
+  end
+
+  task :default => [:spec, 'coveralls:push']
+rescue
+end

data/bin/console

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

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'external_api_service/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "external_api_service"
+  spec.version       = ExternalApiService::VERSION
+  spec.authors       = ["nrakochy"]
+  spec.email         = ["nick.rakochy@gmail.com"]
+  spec.summary       = %q{Make a GET request to an external endpoint using only Ruby standard lib - No external dependencies}
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency 'coveralls', '~> 0.8.1'
+  spec.add_development_dependency 'webmock', '~> 1.21.0'
+  spec.add_development_dependency 'yard', '~> 0.8.7.6'
+end

data/lib/external_api_service/http_client.rb

@@ -0,0 +1,39 @@
+require 'net/http'
+require 'json'
+
+class HTTP_Client
+
+  def get(endpoint_uri)
+    response = get_request(endpoint_uri)
+    parse_response(response)
+  end
+
+  def get_request(endpoint)
+    Net::HTTP.start(endpoint.host, endpoint.port) do |client|
+      retries = 5
+      begin
+        new_request = Net::HTTP::Get.new(endpoint)
+        client.request(new_request)
+      rescue Exception => ex
+        retries -= 1
+        retries > 0 ? retry : error_response(422, ex)
+      end
+    end
+  end
+
+  def parse_response(response)
+    if (response.code != "200" || response.code == nil)
+      { error: response }
+    else
+      JSON.parse(response.body, symbolize_names: true)
+    end
+  end
+
+  private
+
+  def error_response(err_code, exception)
+    error = Struct.new(:code, :exception)
+    error.new(err_code, exception)
+  end
+end
+

data/lib/external_api_service/https_client.rb

@@ -0,0 +1,44 @@
+require 'net/http'
+require 'json'
+require 'thread'
+
+class HTTPS_Client
+
+  def get_queue(url_queue)
+    url_queue.map{|uri| get(uri)}
+  end
+
+  def get(endpoint_uri)
+    response = get_request(endpoint_uri)
+    parse_response(response)
+  end
+
+  def get_request(endpoint)
+    Net::HTTP.start(endpoint.host, endpoint.port, :use_ssl => endpoint.scheme == 'https') do |client|
+      retries = 5
+      begin
+        new_request = Net::HTTP::Get.new(endpoint)
+        client.request(new_request)
+      rescue Exception => ex
+        retries -= 1
+        retries > 0 ? retry : error_response(422, ex)
+      end
+    end
+  end
+
+  def parse_response(response)
+    if (response.code != "200" || response.code == nil)
+      { error: response }
+    else
+      JSON.parse(response.body, symbolize_names: true)
+    end
+  end
+
+  private
+
+  def error_response(err_code, exception)
+    error = Struct.new(:code, :exception)
+    error.new(err_code, exception)
+  end
+end
+

data/lib/external_api_service/uri_builder.rb

@@ -0,0 +1,11 @@
+require 'uri'
+
+class URI_Builder
+
+  def build_uri(url, queries)
+    endpoint = URI(url)
+    endpoint.query = URI.encode_www_form(queries) if !queries.nil?
+    endpoint
+  end
+
+end

data/lib/external_api_service/version.rb

@@ -0,0 +1,3 @@
+module ExternalApiService
+  VERSION = "0.1.1"
+end

data/lib/external_api_service.rb

@@ -0,0 +1,21 @@
+require 'external_api_service/http_client'
+require 'external_api_service/https_client'
+require 'external_api_service/uri_builder'
+
+module ExternalApiService
+
+  # Make a GET request to external endpoint
+  # @param url is required
+  # @param query is optional. Query must be formatted as Ruby hash.
+  #
+  # @return Will transform the JSON to Ruby Hash with symbolized names
+  #
+  # @example
+  # ExternalApiService.get_service("sample_endpoint", {sample_hash: "sample_request"})
+
+  def self.get_service(url, queries = nil)
+    uri = URI_Builder.new.build_uri(url, queries)
+    uri.scheme.include?("https") ? HTTPS_Client.new.get(uri) : HTTP_Client.new.get(uri)
+  end
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: external_api_service
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- nrakochy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+description: 
+email:
+- nick.rakochy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- external_api_service.gemspec
+- lib/external_api_service.rb
+- lib/external_api_service/http_client.rb
+- lib/external_api_service/https_client.rb
+- lib/external_api_service/uri_builder.rb
+- lib/external_api_service/version.rb
+homepage: 
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5
+signing_key: 
+specification_version: 4
+summary: Make a GET request to an external endpoint using only Ruby standard lib -
+  No external dependencies
+test_files: []
+has_rdoc: