redbooth-ruby 0.0.3 → 0.0.4

data/lib/redbooth-ruby/request/response.rb

@@ -0,0 +1,34 @@
+module RedboothRuby
+  module Request
+    # Wraps the API response parsing the json body and keeping interesting headers
+    #
+    class Response
+      attr_accessor :body, :headers, :data, :status
+
+      def initialize(attrs={})
+        @body = attrs[:body]
+        @headers = attrs[:headers]
+        @status = attrs[:status]
+        initialize_data
+      end
+
+      protected
+
+      # initializes the json data with the request body
+      # or empty array if not
+      def initialize_data
+        @data = parse_body || {}
+      end
+
+      # Parses the json body if is a json valid string
+      #
+      def parse_body
+        return unless body.is_a?(String)
+        JSON.parse(body)
+      rescue
+        # not a valid json body
+        nil
+      end
+    end
+  end
+end

data/lib/redbooth-ruby/request/validator.rb

@@ -0,0 +1,85 @@
+module RedboothRuby
+  module Request
+    class Validator
+      attr_reader :info
+      attr_accessor :raw_response, :response
+
+      def initialize(info)
+        @info = info
+      end
+
+      # Validates the given http response creating a response object or
+      # failing with an error and description
+      #
+      # param incoming_response [] http response object
+      # return [RedboothRuby::Request::Response]
+      def validated_response_for(incoming_response)
+        self.raw_response = incoming_response
+        @response = RedboothRuby::Request::Response.new(headers: raw_response.headers,
+                                                        body: raw_response.body,
+                                                        status: raw_response.status.to_i)
+        verify_response_code
+        info.data = response.data
+        validate_response_data
+        response
+      end
+
+      protected
+
+      # Verifies the response status code in case it fails with the dessired error
+      # and message
+      #
+      def verify_response_code
+        status = raw_response.status.to_i
+        case
+        when status == 401
+          verify_authentication_header
+          fail AuthenticationError
+        when status >= 500
+          fail APIError
+        when status >= 404
+          fail NotFound
+        when [102, 202].include?(status)
+          fail Processing, response
+        end
+      end
+
+      # Checks the authetication header to ensure wich is the best error to throw
+      #
+      def verify_authentication_header
+        case raw_response.headers['WWW-Authenticate']
+        when /error\=\"invalid_token\".*expired/
+          fail OauhtTokenExpired
+        when /error\=\"invalid_token\".*revoked/
+          fail OauhtTokenRevoked
+        end
+      end
+
+      # Validates the body data returned in the response in case there is
+      # an embed error it will fail with the dessired error and message
+      #
+      def validate_response_data
+        if response.data.is_a?(Hash)
+          if response.data['error']
+            handle_api_error(response.data['error']['code'], response.data['error']['message'])
+          elsif response.data['errors']
+            response.data['errors'].each do |error|
+              handle_api_error(error['code'], error['message'])
+            end
+          end
+        end
+      end
+
+      def handle_api_error(code, message)
+        error = case code
+                when 1021, 1024  then ObjectNotFound.new(message)
+                when 1300, 1303  then BadRequest.new(message)
+                when 2000        then AuthenticationError.new(message)
+                else
+                  APIError.new(message)
+                end
+        fail error
+      end
+    end
+  end
+end

data/lib/redbooth-ruby/session.rb

@@ -0,0 +1,46 @@
+require 'oauth2'
+
+module RedboothRuby
+  class Session
+
+    attr_accessor :token, :refresh_token, :access_token
+    attr_accessor :consumer_key, :consumer_secret
+    attr_accessor :oauth_verifier, :oauth_token
+
+    OAUTH_URLS =  {
+        :site => 'https://redbooth.com/api/3',
+        :authorize_url => 'https://redbooth.com/oauth2/authorize',
+        :token_url => 'https://redbooth.com/oauth2/token'
+    }
+
+    def initialize(opts = {})
+      @token = opts[:token]
+      @consumer_key = opts[:consumer_key] || RedboothRuby.configuration[:consumer_key]
+      @consumer_secret = opts[:consumer_secret] || RedboothRuby.configuration[:consumer_secret]
+      @oauth_verifier = opts[:oauth_verifier]
+      @oauth_token = opts[:oauth_token]
+    end
+
+    def valid?
+      return false unless token
+      true
+    end
+
+    def client
+      @client ||= OAuth2::Client.new(consumer_key, consumer_secret, OAUTH_URLS)
+    end
+
+    def get_access_token_url
+      url = OAUTH_URLS[:request_token_url]
+      url += "?oauth_verifier=#{oauth_verifier}" if oauth_verifier
+      url += "&oauth_token=#{oauth_token}" if oauth_token
+    end
+
+    def access_token
+      @access_token ||= OAuth2::AccessToken.new(client, token)
+    end
+
+  end
+end
+
+

data/lib/redbooth-ruby/task.rb

@@ -0,0 +1,37 @@
+module RedboothRuby
+  class Task < Base
+    include RedboothRuby::Operations::Index
+    include RedboothRuby::Operations::Create
+    include RedboothRuby::Operations::Update
+    include RedboothRuby::Operations::Show
+    include RedboothRuby::Operations::Delete
+
+    attr_accessor :id,
+                  :name,
+                  :task_list_id,
+                  :comments_count,
+                  :assigned_id,
+                  :is_private,
+                  :project_id,
+                  :urgent,
+                  :user_id,
+                  :position,
+                  :last_activity_id,
+                  :record_conversion_type,
+                  :record_conversion_id,
+                  :metadata,
+                  :subtasks_count,
+                  :resolved_subtasks_count,
+                  :watcher_ids,
+                  :description,
+                  :description_html,
+                  :description_updated_by_user_id,
+                  :updated_by_id,
+                  :deleted,
+                  :status,
+                  :due_on,
+                  :created_at,
+                  :updated_at
+
+  end
+end

data/lib/redbooth-ruby/user.rb

@@ -0,0 +1,13 @@
+module RedboothRuby
+  class User < Base
+    include RedboothRuby::Operations::Index
+    include RedboothRuby::Operations::Show
+
+    attr_accessor :id, :email, :first_name, :last_name, :developer, :created_time,
+      :emails, :storage, :confirmed, :user_id
+
+    def id
+      @id || @user_id
+    end
+  end
+end

data/lib/redbooth-ruby/version.rb

@@ -0,0 +1,3 @@
+module RedboothRuby
+  VERSION = '0.0.4'
+end

data/lib/redbooth-ruby.rb

@@ -0,0 +1,113 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+require 'redbooth-ruby/version'
+
+module RedboothRuby
+  DOMAIN_BASE = nil
+  API_BASE_PATH = 'api'
+  API_VERSION = '3'
+  ROOT_PATH   = File.dirname(__FILE__)
+
+  autoload :Base,           'redbooth-ruby/base'
+  autoload :Client,         'redbooth-ruby/client'
+  autoload :Session,        'redbooth-ruby/session'
+  autoload :Me,             'redbooth-ruby/me'
+  autoload :User,           'redbooth-ruby/user'
+  autoload :Task,           'redbooth-ruby/task'
+  autoload :Organization,   'redbooth-ruby/organization'
+  autoload :Person,         'redbooth-ruby/person'
+  autoload :Project,        'redbooth-ruby/project'
+  autoload :Conversation,   'redbooth-ruby/conversation'
+  autoload :Membership,     'redbooth-ruby/membership'
+
+  module Operations
+    autoload :Base,       'redbooth-ruby/operations/base'
+    autoload :Index,      'redbooth-ruby/operations/index'
+    autoload :Create,     'redbooth-ruby/operations/create'
+    autoload :Delete,     'redbooth-ruby/operations/delete'
+    autoload :Show,       'redbooth-ruby/operations/show'
+    autoload :Update,     'redbooth-ruby/operations/update'
+    autoload :Meta,       'redbooth-ruby/operations/meta'
+  end
+
+  module Request
+    autoload :Base,       'redbooth-ruby/request/base'
+    autoload :Connection, 'redbooth-ruby/request/connection'
+    autoload :Helpers,    'redbooth-ruby/request/helpers'
+    autoload :Info,       'redbooth-ruby/request/info'
+    autoload :Validator,  'redbooth-ruby/request/validator'
+    autoload :Response,   'redbooth-ruby/request/response'
+    autoload :Collection, 'redbooth-ruby/request/collection'
+  end
+
+  class RedboothError < StandardError; end
+  class AuthenticationError < RedboothError; end
+  class OauhtTokenExpired < AuthenticationError; end
+  class OauhtTokenRevoked < AuthenticationError; end
+  class NotFound            < RedboothError; end
+  class APIError            < RedboothError; end
+  class ObjectNotFound      < APIError; end
+  class BadRequest     < APIError; end
+
+  # Signals. Usign errors as control flow
+  #
+  class RedboothSignal < StandardError; end
+  class Processing     < RedboothSignal
+    attr_accessor :response
+
+    def initialize(response, message='')
+      @response = response
+      super(message)
+    end
+  end
+
+
+  # Gives configuration abilities
+  # to setup api_key and api_secret
+  #
+  # @example
+  #   Copy.config do |configuration|
+  #     configuration[:api_key] = '_your_api_key'
+  #     configuration[:api_secret] = '_your_api_secret'
+  #   end
+  #
+  # @return [String] The api key
+  def self.config(&block)
+    default_configuration
+    yield(@@configuration)
+    @@configuration
+  end
+
+  def self.configuration
+    default_configuration
+    @@configuration
+  end
+
+  def self.configuration=(value)
+    default_configuration
+    @@configuration = value
+  end
+
+  # Makes a request against the Copy API
+  #
+  # @param [Symbol] http_method The http method to use, must be one of :get, :post, :put and :delete
+  # @param [String] domain The API domain to use
+  # @param [String] api_url The API url to use
+  # @param [Hash] data The data to send, e.g. used when creating new objects.
+  # @return [Array] The parsed JSON response.
+  def self.request(http_method, domain, api_url, data, options = {})
+    info = Request::Info.new(http_method, domain, api_url, data, options)
+    Request::Base.new(info).perform
+  end
+
+  def self.default_configuration
+    return if defined?(@@configuration)
+    @@configuration ||= {}
+    @@configuration[:api_base] ||= 'redbooth.com'
+    @@configuration[:domain_base] ||= nil
+    @@configuration[:api_base_path] ||= 'api'
+    @@configuration[:api_version] ||= '3'
+    @@configuration[:use_ssl] ||= true
+  end
+end

data/redbooth-ruby.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redbooth-ruby/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'redbooth-ruby'
+  s.version     = RedboothRuby::VERSION
+  s.authors     = ['Andres Bravo', 'Carlos Saura']
+  s.email       = ['support@redbooth.com']
+  s.homepage    = 'https://github.com/teambox/redbooth-ruby'
+  s.summary     = %q{API wrapper for Redbooth.}
+  s.description = %q{API wrapper for Redbooth.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'json', '>= 1.8.1'
+  s.add_dependency 'oauth2', '>= 0.9.3'
+  s.add_dependency(%q<multipart-post>, ['>= 1.1.0'])
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'vcr'
+  s.add_development_dependency 'fakeweb'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redbooth-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andres Bravo
@@ -116,6 +116,41 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/redbooth-ruby.rb
+- lib/redbooth-ruby/base.rb
+- lib/redbooth-ruby/client.rb
+- lib/redbooth-ruby/conversation.rb
+- lib/redbooth-ruby/me.rb
+- lib/redbooth-ruby/membership.rb
+- lib/redbooth-ruby/operations/base.rb
+- lib/redbooth-ruby/operations/create.rb
+- lib/redbooth-ruby/operations/delete.rb
+- lib/redbooth-ruby/operations/index.rb
+- lib/redbooth-ruby/operations/meta.rb
+- lib/redbooth-ruby/operations/show.rb
+- lib/redbooth-ruby/operations/update.rb
+- lib/redbooth-ruby/organization.rb
+- lib/redbooth-ruby/person.rb
+- lib/redbooth-ruby/project.rb
+- lib/redbooth-ruby/request/base.rb
+- lib/redbooth-ruby/request/collection.rb
+- lib/redbooth-ruby/request/connection.rb
+- lib/redbooth-ruby/request/helpers.rb
+- lib/redbooth-ruby/request/info.rb
+- lib/redbooth-ruby/request/response.rb
+- lib/redbooth-ruby/request/validator.rb
+- lib/redbooth-ruby/session.rb
+- lib/redbooth-ruby/task.rb
+- lib/redbooth-ruby/user.rb
+- lib/redbooth-ruby/version.rb
+- redbooth-ruby.gemspec
 - spec/cassettes/RedboothRuby_Conversation/_create/.yml
 - spec/cassettes/RedboothRuby_Conversation/_create/makes_a_new_POST_request_using_the_correct_API_endpoint_to_create_a_specific_conversation.yml
 - spec/cassettes/RedboothRuby_Conversation/_delete/makes_a_new_DELETE_request_using_the_correct_API_endpoint_to_delete_a_specific_conversation.yml
@@ -262,7 +297,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='