external_api_service 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8a6d1ed464dd884eb7ecec6f783d78521006391
-  data.tar.gz: 12c9a87d3e9d9740133cddadb0e7cbe7c94def6d
+  metadata.gz: af81f8d361d5ed627c6f17da68411718d284c534
+  data.tar.gz: e3b73255e7910c738706597346e807425b7adb42
 SHA512:
-  metadata.gz: 00b068a699b4a932442f4b7a1e93760420235e2a05402c1cad9a2e7e41297b40cfc08d4a79357d81e0622ca0a6b620c9aef6dc6be6de44cba862a523062248a6
-  data.tar.gz: abe663289c6bf5ad6d8f4926a486a9c03a971987a495a599a2a7432a54fe46b2c751ff816f4e061d010d3203f2ff1f190c70d1ff271d8495d981625dfe369631
+  metadata.gz: 813fe93f53e076cb4cb69dfc4d4db68becdefe2d7be0f3fb722680fcf5736cfd49807d5edd24baa3bbc532bb90b6b4ae209dc38c4413a782bd2accdd76f33db6
+  data.tar.gz: 1777330e5f6f72c5890bf57a808a71105ba1e88ccd886c48d0b153bcac6b266d0ecd799acf18b6be7f2cd514f7d550b4936a6c0041f47dbb705d7d5c5f2b53a5

data/README.md

@@ -25,11 +25,12 @@ To use, you need to require the service module wherever you are wanting to use i
 
     require ‘ExternalApiService’
 
+### GET
 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”
+    url = 'https://data.cityofchicago.org/resource/dip3-ud6z.json'
     ExternalApiService.get_service(url)
 
     # with params
@@ -39,7 +40,7 @@ It will work with `HTTPS` or `HTTP`. Call `get_service`:
 
 `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”)
+    # First entry from the Chicago Problem Landlord List in Array of Hashes ('https://data.cityofchicago.org/resource/dip3-ud6z.json')
 
     [{:respondent=>”Ravine Properties, LLC”, :secondary_address=>”5849 W ARTHINGTON ST”,
     :location=>{:needs_recoding=>false, :longitude=>”-87.7716557532”, :latitude=>”41.8690630014”},
@@ -47,10 +48,28 @@ It will work with `HTTPS` or `HTTP`. Call `get_service`:
     :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`.
+### POST
+To make a POST request, you need an endpoint (required), the data you want to post, and authentication. Right now it only supports basic auth.  
+The endpoint must accept and return `JSON`.
 
-Only makes GET requests. Probably need to update to make POST requests as well.
+There is a header param available, but it is optional, and `Net/HTTP` handles most of it behind the scenes.
+
+
+  #example: Add a subscriber to your Mailchimp Account (Api V3)
+  auth = {'api_key': '123key'}
+  optional_header = {}
+  data_to_post: {'email' => 'example.email@example.com', 'status' => 'subscribed'}
+  endpoint = 'https://us9.api.mailchimp.com/3.0/lists/123uniquelistID/members'
+  ExternalApiService.post_service(endpoint, data_to_post, auth, optional_header)
+
+Note:
+You have to have the trailing '/' for the path for Ruby to POST properly e.g. http://sample.com/ (I think)
+
+`post_service` will return the body of the response in a Ruby hash with symbolized keys.
+
+## Sandbox
+If you want to fire it up, you can run `bin/console` from the command line to launch it. You still need  `require ExternalApiService`,
+but you can see it in action.
 
 ## Contributing
 

data/lib/external_api_service/http_client.rb

@@ -3,17 +3,25 @@ require 'json'
 
 class HTTP_Client
 
-  def get(endpoint_uri)
-    response = get_request(endpoint_uri)
+  def get(endpoint_uri, credentials)
+    new_request = Net::HTTP::Get.new(endpoint_uri)
+    new_request.basic_auth(credentials[0], credentials[1]) if !credentials.empty?
+    response = make_request(endpoint_uri, new_request)
     parse_response(response)
   end
 
-  def get_request(endpoint)
-    Net::HTTP.start(endpoint.host, endpoint.port) do |client|
+  def post(http_params)
+    new_request = build_post_request(http_params)
+    response = make_request(http_params[:uri], new_request)
+    parse_response(response)
+  end
+
+  def make_request(endpoint, formatted_request)
+    check_ssl = (endpoint.scheme == "https")
+    Net::HTTP.start(endpoint.host, endpoint.port, :use_ssl => check_ssl) do |client|
       retries = 5
       begin
-        new_request = Net::HTTP::Get.new(endpoint)
-        client.request(new_request)
+        client.request(formatted_request)
       rescue Exception => ex
         retries -= 1
         retries > 0 ? retry : error_response(422, ex)
@@ -22,13 +30,22 @@ class HTTP_Client
   end
 
   def parse_response(response)
-    if (response.code != "200" || response.code == nil)
-      { error: response }
-    else
+    if (response.code =~ /^2/ )
       JSON.parse(response.body, symbolize_names: true)
+    else
+      { error: response }
     end
   end
 
+  def build_post_request(http_params)
+    http_params[:header_params]["Content-Type"] = "application/json"
+    new_request = Net::HTTP::Post.new(http_params[:uri], http_params[:header_params])
+    new_request.basic_auth(http_params[:credentials][0], http_params[:credentials][1])
+    new_request.body = http_params[:data].to_json
+    new_request
+  end
+
+
   private
 
   def error_response(err_code, exception)

data/lib/external_api_service/uri_builder.rb

@@ -2,10 +2,11 @@ require 'uri'
 
 class URI_Builder
 
-  def build_uri(url, queries)
+  def self.build_uri(url, queries = {})
     endpoint = URI(url)
-    endpoint.query = URI.encode_www_form(queries) if !queries.nil?
+    endpoint.query = URI.encode_www_form(queries) if !queries.empty?
     endpoint
   end
 
 end
+

data/lib/external_api_service/version.rb

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

data/lib/external_api_service.rb

@@ -1,5 +1,4 @@
 require 'external_api_service/http_client'
-require 'external_api_service/https_client'
 require 'external_api_service/uri_builder'
 
 module ExternalApiService
@@ -7,15 +6,43 @@ module ExternalApiService
   # Make a GET request to external endpoint
   # @param url is required
   # @param query is optional. Query must be formatted as Ruby hash.
+  # @param auth is optional. If you choose to include it,
+  # You must format it as a hash with string key/value {"username" => "password"}
   #
   # @return Will transform the JSON to Ruby Hash with symbolized names
   #
   # @example
-  # ExternalApiService.get_service("sample_endpoint", {sample_hash: "sample_request"})
+  # ExternalApiService.get_service("sample_endpoint", {sample_search_query: "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)
+  def self.get_service(url, queries = {}, credentials = {})
+    credentials_formatted_for_auth = credentials.to_a.flatten
+    uri = URI_Builder.build_uri(url, queries)
+    HTTP_Client.new.get(uri, credentials_formatted_for_auth)
+  end
+
+  # Make a JSON POST request to external endpoint
+  # @param url is required
+  # @param data_to_post is required, since you are a making POST request after all.
+  # @param auth is required, as it is not an idempotent action.
+  # You must format it as a hash of strings (both key and value) e.g. {"username" => "password"}
+  # @param header_params are optional. This sets content-type to "application/json", so do not include Content-Type.
+  # You get several free headers with the Net/HTTP class, but it is there if you want it. Must be a hash
+  #
+  # @return Will transform the JSON to Ruby Hash with symbolized names
+  #
+  # @example
+  # auth = {"api_key": "123key"}
+  # data_to_post: {sample_data: "sample"}
+  # ExternalApiService.post_service("sample_endpoint", data_to_post, auth)
+  #
+  # Note:
+  # You have to have the trailing '/' for the path for Ruby to POST properly e.g. http://sample.com/
+
+  def self.post_service(url, data_to_post, credentials, http_header_params = {})
+    credentials_formatted_for_auth = credentials.to_a.flatten
+    uri = URI_Builder.build_uri(url)
+    http_params = { uri: uri, data: data_to_post, credentials: credentials_formatted_for_auth, header_params: http_header_params }
+    HTTP_Client.new.post(http_params)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: external_api_service
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - nrakochy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -113,7 +113,6 @@ files:
 - 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: 

data/lib/external_api_service/https_client.rb

@@ -1,44 +0,0 @@
-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
-