kickbox-1.0.5 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 95ed4a1d21cc152872d92dda532f3bc845fd1f03
+  data.tar.gz: 7c53e9f777202f680ab3c97defd9118a25a58632
+SHA512:
+  metadata.gz: fff03a7c82b0e8af8386c82b957c44453d07fcf0936991d16ceaa1478c40bf492a070a016d2fbd38147acd5c11e085363f852c7a180cbee7e4db00ff042dd30e
+  data.tar.gz: b639f4b9289126fd969fa71b76e531d20f0fc9429cf0d8d16bf1505d6a8f886ac9ab11a71211d6f5ccf2e649e977fb9d643ea80897d36ab3d034a243db9722d3

data/lib/kickbox.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+
+require "kickbox/client"
+require "kickbox/error"
+require "kickbox/http_client"
+
+module Kickbox
+end

data/lib/kickbox/api/kickbox.rb

@@ -0,0 +1,27 @@
+module Kickbox
+
+  module Api
+
+    # 
+    class Kickbox
+
+      def initialize(client)
+        @client = client
+      end
+
+      # Email Verification
+      #
+      # '/verify?email=:email' GET
+      #
+      # email - Email address to verify
+      def verify(email, options = {})
+        body = options.fetch(:query, {})
+
+        @client.get("/verify?email=#{email}", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/kickbox/client.rb

@@ -0,0 +1,21 @@
+require "faraday"
+require "json"
+
+require "kickbox/api/kickbox"
+
+module Kickbox
+
+  class Client
+
+    def initialize(auth = {}, options = {})
+      @http_client = Kickbox::HttpClient::HttpClient.new(auth, options)
+    end
+
+    # 
+    def kickbox()
+      Kickbox::Api::Kickbox.new(@http_client)
+    end
+
+  end
+
+end

data/lib/kickbox/error.rb

@@ -0,0 +1,9 @@
+require "kickbox/error/client_error"
+
+module Kickbox
+
+  module Error
+
+  end
+
+end

data/lib/kickbox/error/client_error.rb

@@ -0,0 +1,18 @@
+module Kickbox
+
+  module Error
+
+    class ClientError < ::StandardError
+
+      attr_reader :code
+
+      def initialize(message, code)
+        @code = code
+        super message
+      end
+
+    end
+
+  end
+
+end

data/lib/kickbox/http_client.rb

@@ -0,0 +1,123 @@
+require "kickbox/http_client/auth_handler"
+require "kickbox/http_client/error_handler"
+require "kickbox/http_client/request_handler"
+require "kickbox/http_client/response"
+require "kickbox/http_client/response_handler"
+
+module Kickbox
+
+  module HttpClient
+
+    # Main HttpClient which is used by Api classes
+    class HttpClient
+
+      attr_accessor :options, :headers
+
+      def initialize(auth = {}, options = {})
+
+        if auth.is_a?(String)
+          auth = { :http_header => auth }
+        end
+
+        @options = {
+          :base => "https://api.kickbox.io",
+          :api_version => "v1",
+          :user_agent => "alpaca/0.2.1 (https://github.com/pksunkara/alpaca)"
+        }
+
+        @options.update(options)
+
+        @headers = {
+          "user-agent" => @options[:user_agent]
+        }
+
+        if @options.has_key?(:headers)
+          @headers.update(Hash[@options[:headers].map { |k, v| [k.downcase, v] }])
+          @options.delete(:headers)
+        end
+
+        @client = Faraday.new(@options[:base]) do |conn|
+          conn.use(Kickbox::HttpClient::AuthHandler, auth)
+          conn.use(Kickbox::HttpClient::ErrorHandler)
+
+          conn.adapter(Faraday.default_adapter)
+        end
+      end
+
+      def get(path, params = {}, options = {})
+        request(path, nil, "get", options.merge({ :query => params }))
+      end
+
+      def post(path, body = {}, options = {})
+        request(path, body, "post", options)
+      end
+
+      def patch(path, body = {}, options = {})
+        request(path, body, "patch", options)
+      end
+
+      def delete(path, body = {}, options = {})
+        request(path, body, "delete", options)
+      end
+
+      def put(path, body = {}, options = {})
+        request(path, body, "put", options)
+      end
+
+      # Intermediate function which does three main things
+      #
+      # - Transforms the body of request into correct format
+      # - Creates the requests with give parameters
+      # - Returns response body after parsing it into correct format
+      def request(path, body, method, options)
+        options = @options.merge(options)
+
+        options[:headers] = options[:headers] || {}
+        options[:headers] = @headers.merge(Hash[options[:headers].map { |k, v| [k.downcase, v] }])
+
+        options[:body] = body
+
+        if method != "get"
+          options[:body] = options[:body] || {}
+          options = set_body(options)
+        end
+
+        response = create_request(method, path, options)
+
+        body = get_body(response)
+
+        Kickbox::HttpClient::Response.new(body, response.status, response.headers)
+      end
+
+      # Creating a request with the given arguments
+      #
+      # If api_version is set, appends it immediately after host
+      def create_request(method, path, options)
+        version = options.has_key?(:api_version) ? "/#{options[:api_version]}" : ""
+
+        path = "#{version}#{path}"
+
+        instance_eval <<-RUBY, __FILE__, __LINE__ + 1
+          @client.#{method}(path) do |req|
+            req.body = options[:body]
+            req.headers.update(options[:headers])
+            req.params.update(options[:query]) if options[:query]
+          end
+        RUBY
+      end
+
+      # Get response body in correct format
+      def get_body(response)
+        Kickbox::HttpClient::ResponseHandler.get_body(response)
+      end
+
+      # Set request body in correct format
+      def set_body(options)
+        Kickbox::HttpClient::RequestHandler.set_body(options)
+      end
+
+    end
+
+  end
+
+end

data/lib/kickbox/http_client/auth_handler.rb

@@ -0,0 +1,73 @@
+require "base64"
+
+module Kickbox
+
+  module HttpClient
+
+    # AuthHandler takes care of devising the auth type and using it
+    class AuthHandler < Faraday::Middleware
+
+      HTTP_HEADER = 1
+
+      def initialize(app, auth = {}, options = {})
+        @auth = auth
+        super(app)
+      end
+
+      def call(env)
+        if !@auth.empty?
+          auth = get_auth_type
+          flag = false
+
+          if auth == HTTP_HEADER
+            env = http_header(env)
+            flag = true
+          end
+
+          if !flag
+            raise StandardError.new "Unable to calculate authorization method. Please check"
+          end
+        else
+          raise StandardError.new "Server requires authentication to proceed further. Please check"
+        end
+
+        @app.call(env)
+      end
+
+      # Calculating the Authentication Type
+      def get_auth_type()
+
+        if @auth.has_key?(:http_header)
+          return HTTP_HEADER
+        end
+
+        return -1
+      end
+
+      # Authorization with HTTP header
+      def http_header(env)
+        env[:request_headers]["Authorization"] = "token #{@auth[:http_header]}"
+
+        return env
+      end
+
+      def query_params(url)
+        if url.query.nil? or url.query.empty?
+          {}
+        else
+          Faraday::Utils.parse_query(url.query)
+        end
+      end
+
+      def merge_query(env, query)
+        query = query.update query_params(env[:url])
+
+        env[:url].query = Faraday::Utils.build_query(query)
+
+        return env
+      end
+    end
+
+  end
+
+end

data/lib/kickbox/http_client/error_handler.rb

@@ -0,0 +1,51 @@
+module Kickbox
+
+  module HttpClient
+
+    # ErrorHanlder takes care of selecting the error message from response body
+    class ErrorHandler < Faraday::Middleware
+
+      def initialize(app)
+        super(app)
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |env|
+          code = env[:response].status
+          type = env[:response].headers["content-type"]
+
+          case code
+          when 500...599
+            raise Kickbox::Error::ClientError.new("Error #{code}", code)
+          when 400...499
+            body = Kickbox::HttpClient::ResponseHandler.get_body(env[:response])
+            message = ""
+
+            # If HTML, whole body is taken
+            if body.is_a?(String)
+              message = body
+            end
+
+            # If JSON, a particular field is taken and used
+            if type.include?("json") and body.is_a?(Hash)
+              if body.has_key?("message")
+                message = body["message"]
+              else
+                message = "Unable to select error message from json returned by request responsible for error"
+              end
+            end
+
+            if message == ""
+              message = "Unable to understand the content type of response returned by request responsible for error"
+            end
+
+            raise Kickbox::Error::ClientError.new message, code
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/kickbox/http_client/request_handler.rb

@@ -0,0 +1,24 @@
+module Kickbox
+
+  module HttpClient
+
+    # RequestHandler takes care of encoding the request body into format given by options
+    class RequestHandler
+
+      def self.set_body(options)
+        type = options.fetch(:request_type, "raw")
+
+        # Raw body
+        if type == "raw"
+          options[:body] = options[:body].is_a?(Hash) ? "" : options[:body]
+          options[:headers].delete("content-type")
+        end
+
+        return options
+      end
+
+    end
+
+  end
+
+end

data/lib/kickbox/http_client/response.rb

@@ -0,0 +1,20 @@
+module Kickbox
+
+  module HttpClient
+
+    # Response object contains the response returned by the client
+    class Response
+
+      attr_accessor :body, :code, :headers
+
+      def initialize(body, code, headers)
+        @body = body
+        @code = code
+        @headers = headers
+      end
+
+    end
+
+  end
+
+end

data/lib/kickbox/http_client/response_handler.rb

@@ -0,0 +1,24 @@
+module Kickbox
+
+  module HttpClient
+
+    # ResponseHandler takes care of decoding the response body into suitable type
+    class ResponseHandler
+
+      def self.get_body(response)
+        type = response.headers["content-type"]
+        body = response.body
+
+        # Response body is in JSON
+        if type.include?("json")
+          body = JSON.parse body
+        end
+
+        return body
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: kickbox-1.0.5
+version: !ruby/object:Gem::Version
+  version: 1.0.5
+platform: ruby
+authors:
+- Chaitanya Surapaneni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: Official kickbox API library client for ruby
+email: chaitanya.surapaneni@kickbox.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/kickbox.rb
+- lib/kickbox/api/kickbox.rb
+- lib/kickbox/client.rb
+- lib/kickbox/error.rb
+- lib/kickbox/error/client_error.rb
+- lib/kickbox/http_client.rb
+- lib/kickbox/http_client/auth_handler.rb
+- lib/kickbox/http_client/error_handler.rb
+- lib/kickbox/http_client/request_handler.rb
+- lib/kickbox/http_client/response.rb
+- lib/kickbox/http_client/response_handler.rb
+homepage: http://kickbox.io
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Official kickbox API library client for ruby
+test_files: []