takeout 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2031cb01ff9f1e947b56c0425e139c1844d9c900
-  data.tar.gz: 40cc086b045ed2774bf546636d3bc30afdedef2c
+  metadata.gz: 4dc87fd70527056a70cf40eea35d282d148acd4f
+  data.tar.gz: e8df926a3d6df0f27c813d99b08dff72a759e460
 SHA512:
-  metadata.gz: ac33508401257dedea5dd3c577bd9d94e2c6c87d4341e90a24fb9b6b46ee746ac461d986d1066add3cfe274e63fc6b6a5914d5d66d5ff3bfae35a6203eade998
-  data.tar.gz: 6090c18d3bebfe54cfcc689a881d1814aa12d3a8dd3ead6ef40a6c454697b3def7ebc22c9a29aaa295f8f235fefc3f9415ef3ec4e34cda5eed75bbb5f995bc76
+  metadata.gz: bd7596e61f5e2dc57c4567322b47eaa8b50b17c2cbcc24323b74357fd425bc03017d08dc0a8cc8a29793377bfbb01b3e5e57593fdb8d4a32b05f806ddfea25fa
+  data.tar.gz: 8871654e9b355e8de3001ff3978f8ab2b57ea4f19dcd17ac3dc71b41e51ce189d1de5a86a21c9fb7945711f1aff6a0282ff1e2432910c80066a5d7f1fbcef0ed

data/lib/takeout/client.rb

@@ -27,13 +27,10 @@ module Takeout
     # @return [String] the uri to send requests to
     attr_accessor :uri
 
-    # @return [Hash] the hash containing the endpoints by request type to generate methods for
-    attr_reader :endpoints
-
     attr_accessor :port
 
     # A constant specifying the kind of event callbacks to raise errors for
-    FAILURES = [:failure, :missing, :redirect]
+    FAILURES = [:failure, :missing]
 
     # The main client initialization method.
     # ==== Attributes
@@ -42,7 +39,6 @@ module Takeout
     # ==== Options
     #
     # * +:uri+ - A string defining the URI for the API to call.
-    # * +:endpoints+ - A hash containing the endpoints by request type to generate methods for
     # * +:headers+ - A hash specifying the headers to apply to each request
     # * +:ssl+ - A boolean to specify whether or not SSL is turned on
     # * +:schemas+ - A hash specifying the custom per-endpoint schema templates
@@ -67,13 +63,6 @@ module Takeout
       return !port.nil?
     end
 
-    # Sets the instance variable and then generates the dynamic methods by calling #generate_enpoint_methods
-    # @param [Hash] value A hash specifying the custom per-endpoint schema templates
-    def endpoints=(value)
-      generate_endpoint_methods(value)
-      @endpoints = value
-    end
-
     # Flips the @ssl instance variable to true
     def enable_ssl
       @ssl=true
@@ -86,31 +75,6 @@ module Takeout
 
     private
 
-    # Generates the dynamic (request_type)_(endpoint_name) methods that allow you to access your API.
-    # @param [Hash] endpoints A hash with the form {request_type: :endpoint_name} or {request_type: [:endpoint_name1, :endpoint_name_2]}
-    def generate_endpoint_methods(endpoints)
-      endpoints.each do |request_type, endpoint_names|
-        # Force any give values into an array and then iterate over that
-        [endpoint_names].flatten(1).each do |request_name|
-          define_singleton_method("#{request_type}_#{request_name}".to_sym) do |options={}|
-            # Extract values that we store separately from the options hash and then clean it up
-            headers.merge!(options[:headers]) if options[:headers]
-
-            # Merge in global options
-            options.merge!(@options) if @options
-
-            # Build the request_url and update the options to remove templated values (if there are any)
-            request_url, options = generate_request_url(request_name, request_type, options)
-
-            # Clean up options hash before performing request
-            [:headers, :extension, :object_id].each { |value| options.delete(value)}
-
-            return perform_curl_request(request_type, request_url, options, headers)
-          end
-        end
-      end
-    end
-
     # Render out the template values and return the updated options hash
     # @param [String] endpoint
     # @param [String] request_type
@@ -159,12 +123,13 @@ module Takeout
           curl.password = options[:password]
         end
 
-        curl.on_success {|response| @parsed_body, @failure = Oj.load(response.body_str), false }
+        curl.on_success {|response| @parsed_body, @failure = Takeout::Response.new(headers: response.headers, body: Oj.load(response.body_str), response: response), false}
+        curl.on_redirect {|response| @parsed_body, @failure = Takeout::Response.new(headers: response.headers, body: Oj.load(response.body_str), response: response), false}
 
-        FAILURES.each { |failure_type| curl.send("on_#{failure_type}") {@failure=true} }
+        FAILURES.each { |failure_type| curl.send("on_#{failure_type}") {|response| @parsed_body, @failure = Takeout::Response.new(headers: response.headers, body: Oj.load(response.body_str), response: response), true} }
       end
 
-      raise Takeout::EndpointFailureError.new(curl, request_type) if @failure
+      raise Takeout::EndpointFailureError.new(curl, request_type, @parsed_body) if @failure
 
       return @parsed_body
     end
@@ -176,10 +141,10 @@ module Takeout
 
       # Generate URL based on if the custom schema exists, and if there is a given object_id
       request_url = if custom_schema.nil? || (custom_schema && custom_schema.empty?)
-                      (options[:object_id] ? url("/#{endpoint_name.to_s}/#{options[:object_id]}") : url("/#{endpoint_name.to_s}"))
-                    else
-                      url(custom_schema)
-                    end
+        (options[:object_id] ? url("/#{endpoint_name.to_s}/#{options[:object_id]}") : url("/#{endpoint_name.to_s}"))
+      else
+        url(custom_schema)
+      end
 
       # Append extension if one is given
       request_url = append_extension(request_url, options)
@@ -195,7 +160,6 @@ module Takeout
     def extract_instance_variables_from_options(options)
       # Set instance variables
       @uri = options[:uri] || ''
-      self.endpoints = options[:endpoints] || {}
       @headers = options[:headers] || {}
       @schemas = options[:schemas] || {}
       @debug = options[:debug]
@@ -211,5 +175,30 @@ module Takeout
       opts = port? ? {host: @uri, path: endpoint, port: port} : {host: @uri, path: endpoint}
       ssl? ? URI::HTTPS.build(opts) : URI::HTTP.build(opts)
     end
+
+    def method_missing(method_sym, *attributes, &block)
+      request_type = method_sym.to_s.scan(/^(?:get|post|put|delete|patch|update)/).first
+      request_name = method_sym.to_s.scan(/(?<=_{1}).*/).first
+      if (request_type && request_name)
+        self.define_singleton_method(method_sym) do |options={}, &block|
+          # Extract values that we store separately from the options hash and then clean it up
+          headers.merge!(options[:headers]) if options[:headers]
+
+          # Merge in global options
+          options.merge!(@options) if @options
+
+          # Build the request_url and update the options to remove templated values (if there are any)
+          request_url, options = generate_request_url(request_name, request_type, options)
+
+          # Clean up options hash before performing request
+          [:headers, :extension, :object_id, :endpoint].each { |value| options.delete(value)}
+
+          return perform_curl_request(request_type, request_url, options, headers)
+        end
+        self.send(method_sym, *attributes, &block)
+      else
+        super
+      end
+    end
   end
 end

data/lib/takeout/endpoint_failure_error.rb

@@ -1,9 +1,9 @@
 module Takeout
   class EndpointFailureError < StandardError
-    attr_reader :object, :request_type, :request_url, :response_code
+    attr_reader :object, :request_type, :request_url, :response_code, :response
 
-    def initialize(object, request_type)
-      @object, @request_type = object, request_type
+    def initialize(object, request_type, response)
+      @object, @request_type, @response = object, request_type, response
     end
 
     def message

data/lib/takeout/response.rb

@@ -0,0 +1,28 @@
+module Takeout
+  class Response
+    attr_accessor :headers
+    attr_accessor :body
+    attr_accessor :response
+    attr_accessor :options
+
+    def initialize(options={})
+      if block_given?
+        yield self
+      else
+        extract_instance_variables_from_options(options)
+      end
+    end
+
+    def extract_instance_variables_from_options(options)
+      # Set instance variables
+      @headers = options[:headers] || ''
+      @body = options[:body] || {}
+      @response = options[:response] || {}
+
+
+      # Clean instance variables out of options hash and set that as options instance variable
+      [:headers, :body, :response].each { |v| options.delete(v) }
+      @options = options
+    end
+  end
+end

data/lib/takeout/version.rb

@@ -1,3 +1,3 @@
 module Takeout
-  VERSION = "0.1.3"
+  VERSION = "1.0.0"
 end

data/lib/takeout.rb

@@ -1,5 +1,6 @@
 require 'takeout/version'
 require 'takeout/endpoint_failure_error'
+require 'takeout/response'
 require 'takeout/client.rb'
 
 module Takeout

data/spec/client_spec.rb

@@ -4,14 +4,7 @@ describe Takeout::Client do
   let (:client) {Takeout::Client.new(uri: 'test.com', endpoints: {get: ENDPOINTS, post: ENDPOINTS, put: ENDPOINTS, delete: ENDPOINTS})}
 
   context 'initialization' do
-    it 'creates methods for all provided endpoints' do
-      expect((client.methods - Object.methods - Takeout::Client.instance_methods(false))).to eq([:get_posts, :get_fake_failure, :get_fake_missing, :get_fake_redirect,
-                                                                                                 :post_posts, :post_fake_failure, :post_fake_missing, :post_fake_redirect,
-                                                                                                 :put_posts, :put_fake_failure, :put_fake_missing, :put_fake_redirect,
-                                                                                                 :delete_posts, :delete_fake_failure, :delete_fake_missing, :delete_fake_redirect])
-    end
-
-    it 'yeilds when block is given' do
+    it 'yields when block is given' do
       expect { |b| Takeout::Client.new(&b) }.to yield_with_args (Takeout::Client)
     end
   end
@@ -59,8 +52,12 @@ describe Takeout::Client do
   end
 
   context 'get' do
-    it 'returns array on success' do
-      expect(client.get_posts).to be_an(Array)
+    it 'returns Takeout::Response on success' do
+      expect(client.get_posts).to be_an(Takeout::Response)
+    end
+
+    it 'returns an array in its body on success' do
+      expect(client.get_posts.body).to be_an(Array)
     end
 
     it 'raises EndpointFailureError on missing' do
@@ -74,8 +71,12 @@ describe Takeout::Client do
   end
 
   context 'post' do
-    it 'returns hash on success' do
-      expect(client.post_posts).to be_an(Hash)
+    it 'returns Takeout::Response on success' do
+      expect(client.post_posts).to be_an(Takeout::Response)
+    end
+
+    it 'returns as hash in its body on success' do
+      expect(client.post_posts.body).to be_an(Hash)
     end
 
     it 'raises EndpointFailureError when called without object_id' do
@@ -93,8 +94,12 @@ describe Takeout::Client do
   end
 
   context 'delete' do
-    it 'returns hash on success with object_id' do
-      expect(client.delete_posts(object_id: 1)).to be_a(Hash)
+    it 'returns Takeout::Response on success' do
+      expect(client.delete_posts(object_id: 1)).to be_a(Takeout::Response)
+    end
+
+    it 'returns hash in its body on success with object_id' do
+      expect(client.delete_posts(object_id: 1).body).to be_a(Hash)
     end
 
     it 'raises EndpointFailureError when called without object_id' do
@@ -113,8 +118,12 @@ describe Takeout::Client do
   end
 
   context 'put' do
-    it 'returns hash on success with object_id' do
-      expect(client.put_posts(object_id: 1)).to be_a(Hash)
+    it 'returns Takeout::Response on success' do
+      expect(client.put_posts(object_id: 1)).to be_a(Takeout::Response)
+    end
+
+    it 'returns hash in its body on success with object_id' do
+      expect(client.put_posts(object_id: 1).body).to be_a(Hash)
     end
 
     it 'raises EndpointFailureError when called without object_id' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: takeout
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Kyle Lucas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -155,6 +155,7 @@ files:
 - lib/takeout.rb
 - lib/takeout/client.rb
 - lib/takeout/endpoint_failure_error.rb
+- lib/takeout/response.rb
 - lib/takeout/version.rb
 - spec/.DS_Store
 - spec/client_spec.rb