visupedia 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ace392474dc229b91478077cad68dd65b7aea58
+  data.tar.gz: 4d940104f7869d1bba0ff19231df510861b8d4d0
+SHA512:
+  metadata.gz: c7f03a9064fbb90ea3ac5f07941a279c25689cb800c722082d0a07889f66c1c845915ffc6bac0aba31b3b93cecbbf9a67b265ed5e6af1c9a55095f7156d672da
+  data.tar.gz: ed453eab8c26067c2c4eddcbd04d881b61197112eaa809c73a278be325e8fdda045607fd196106465ec98e4566784b2541462ab7b7fcbdb4bc43fbf911d56b34

data/lib/visupedia.rb

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

data/lib/visupedia/api/visu.rb

@@ -0,0 +1,35 @@
+module Visupedia
+
+  module Api
+
+    # Returns an MyVisu api instance
+    #
+    # key - The api key provided by Visupedia
+    class Visu
+
+      def initialize(key, client)
+        @key = key
+        @client = client
+      end
+
+      # Returns all information about the wanted Visu
+      #
+      # '/api?key=:key&id=:id&lang=:lang&version=:version' GET
+      #
+      # id - The unique ID of the Visu
+      # lang - The language code wanted for the Visu
+      # version - Use a specific version of our API
+      def get(id, lang, version, options = {})
+        body = options.fetch(:query, {})
+        body[:id] = id
+        body[:lang] = lang
+        body[:version] = version
+
+        @client.get("/api?key=#{@key}&id=#{id}&lang=#{lang}&version=#{version}", body, options)
+      end
+
+    end
+
+  end
+
+end

data/lib/visupedia/client.rb

@@ -0,0 +1,23 @@
+require "faraday"
+require "json"
+
+require "visupedia/api/visu"
+
+module Visupedia
+
+  class Client
+
+    def initialize(auth = {}, options = {})
+      @http_client = Visupedia::HttpClient::HttpClient.new(auth, options)
+    end
+
+    # Returns an MyVisu api instance
+    #
+    # key - The api key provided by Visupedia
+    def visu(key)
+      Visupedia::Api::Visu.new(key, @http_client)
+    end
+
+  end
+
+end

data/lib/visupedia/error.rb

@@ -0,0 +1,9 @@
+require "visupedia/error/client_error"
+
+module Visupedia
+
+  module Error
+
+  end
+
+end

data/lib/visupedia/error/client_error.rb

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

data/lib/visupedia/http_client.rb

@@ -0,0 +1,118 @@
+require "visupedia/http_client/auth_handler"
+require "visupedia/http_client/error_handler"
+require "visupedia/http_client/request_handler"
+require "visupedia/http_client/response"
+require "visupedia/http_client/response_handler"
+
+module Visupedia
+
+  module HttpClient
+
+    # Main HttpClient which is used by Api classes
+    class HttpClient
+
+      attr_accessor :options, :headers
+
+      def initialize(auth = {}, options = {})
+
+        @options = {
+          :base => "https://dev.visupedia.net",
+          :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(Visupedia::HttpClient::AuthHandler, auth)
+          conn.use(Visupedia::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)
+
+        Visupedia::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)
+        Visupedia::HttpClient::ResponseHandler.get_body(response)
+      end
+
+      # Set request body in correct format
+      def set_body(options)
+        Visupedia::HttpClient::RequestHandler.set_body(options)
+      end
+
+    end
+
+  end
+
+end

data/lib/visupedia/http_client/auth_handler.rb

@@ -0,0 +1,53 @@
+require "base64"
+
+module Visupedia
+
+  module HttpClient
+
+    # AuthHandler takes care of devising the auth type and using it
+    class AuthHandler < Faraday::Middleware
+
+      def initialize(app, auth = {}, options = {})
+        @auth = auth
+        super(app)
+      end
+
+      def call(env)
+        if !@auth.empty?
+          auth = get_auth_type
+          flag = false
+
+          if !flag
+            raise StandardError.new "Unable to calculate authorization method. Please check"
+          end
+        end
+
+        @app.call(env)
+      end
+
+      # Calculating the Authentication Type
+      def get_auth_type()
+
+        return -1
+      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/visupedia/http_client/error_handler.rb

@@ -0,0 +1,42 @@
+module Visupedia
+
+  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 Visupedia::Error::ClientError.new("Error #{code}", code)
+          when 400...499
+            body = Visupedia::HttpClient::ResponseHandler.get_body(env[:response])
+            message = ""
+
+            # If HTML, whole body is taken
+            if body.is_a?(String)
+              message = body
+            end
+
+            if message == ""
+              message = "Unable to understand the content type of response returned by request responsible for error"
+            end
+
+            raise Visupedia::Error::ClientError.new message, code
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/visupedia/http_client/request_handler.rb

@@ -0,0 +1,24 @@
+module Visupedia
+
+  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, "form")
+
+        # 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/visupedia/http_client/response.rb

@@ -0,0 +1,20 @@
+module Visupedia
+
+  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/visupedia/http_client/response_handler.rb

@@ -0,0 +1,19 @@
+module Visupedia
+
+  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
+
+        return body
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: visupedia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gaël Gillard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 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.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+description: Official Visupedia API library client for ruby
+email: dev@visupedia.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/visupedia.rb
+- lib/visupedia/api/visu.rb
+- lib/visupedia/client.rb
+- lib/visupedia/error.rb
+- lib/visupedia/error/client_error.rb
+- lib/visupedia/http_client.rb
+- lib/visupedia/http_client/auth_handler.rb
+- lib/visupedia/http_client/error_handler.rb
+- lib/visupedia/http_client/request_handler.rb
+- lib/visupedia/http_client/response.rb
+- lib/visupedia/http_client/response_handler.rb
+homepage: http://visupedia.net
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Official Visupedia API library client for ruby
+test_files: []