redbooth-ruby 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01abc6acf999dcb398f009e071a81d3fd029989e
-  data.tar.gz: bcfe3834d00cf479fdf2189312a43dc96efa7917
+  metadata.gz: 1c965740525e418665ebed6cdfc26ab17a67fb5e
+  data.tar.gz: 76bd8e60f6b972b540b23feb613e7e1cb2241544
 SHA512:
-  metadata.gz: 614a60b311e36b025d83fb9733d6741a32891b0b672028cdd389265972c764d9185b2a952300f04140385469c9c45adb296b6a9d90c272f5ea422c5dfa866c07
-  data.tar.gz: 075d63411197758c8bcb164140615013f64cdede1a1ad6115aefb78e2a47a1cb1581677f9100ff3820fc39045f8ac1040353f517c6c89523b9291aa3fd9b4416
+  metadata.gz: 6280ee42271771c0c17d57107084382b841f14e44976426b62eb7da0964214eb4ab8dd42bb3b90d743bd807bfa65218e4b809e217cce5f71acedb4e0303ccfe5
+  data.tar.gz: 46075bd7b3d79e78762958021e89d38363fb1be2d7a73c94ac7dad71dceaa3e8a1f35f30555aa5ede4bbcb1abd3fce359ce00798df7eca1a29db4b6617c96583

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.html
+/.rvmrc
+.project
+.ruby-version
+.ruby-gemset
+/spec/integration/*
+/coverage

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem 'rspec'
+gem 'rake'
+gem 'webmock'
+gem 'pry'
+gem 'multipart-post', '>= 1.1.0'
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2012 Redbooth
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,429 @@
+[![Build Status](https://magnum.travis-ci.com/teambox/redbooth-ruby.svg?token=DytWKainUGNzXxdrekWH&branch=feature/tasks)](https://magnum.travis-ci.com/teambox/redbooth-ruby) [![Code Climate](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/badges/11031f420440e8a9f525/gpa.svg)](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/feed) [![Test Coverage](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/badges/11031f420440e8a9f525/coverage.svg)](https://codeclimate.com/repos/5461c4f6e30ba075bc0a0ab0/feed) [![Inline docs](http://inch-ci.org/github/teambox/redbooth-ruby.svg?branch=master)](http://inch-ci.org/github/teambox/redbooth-ruby)
+
+Redbooth-Ruby
+======
+
+This is a Ruby wrapper for redbooth's API.
+
+Documentation
+=====
+
+We use YARD for documentation.
+
+Usage
+======
+
+First, you've to install the gem
+
+```Ruby
+  gem install redbooth-ruby
+```
+
+and require it
+
+```Ruby
+  require 'redbooth-ruby'
+```
+
+and set up your app credentials
+
+
+```Ruby
+  RedboothRuby.config do |configuration|
+    configuration[:consumer_key] = '_your_consumer_key_'
+    configuration[:consumer_secret] = '_your_consumer_secret_'
+  end
+```
+
+in fact this last step is optional (yes! we support multiple applications) but if as most fo the humans you use only one redbooth app, this is the easyest way to go.
+
+
+Oauth
+=====
+
+*[Redbooth oauth2 API documentation](https://www.redbooth.com/developer/documentation#authentication)*
+
+using omniauth? :+1: good choice, just try this gem
+
+  *[teambox/omniauth-redbooth](https://github.com/teambox/omniauth-redbooth)*
+
+not using omniauth,? no prob oauth implementation comming soon
+
+  ...
+
+
+Client
+======
+
+Everything starts with the client, once you have the user credentials you should create a session and a client to start interaction with the API
+
+```Ruby
+  session = RedboothRuby::Session.new(
+    token: '_your_user_token_'
+  )
+  client = RedboothRuby::Client.new(session)
+```
+
+Now you can perform any user api call inside the clien wrapper
+
+```Ruby
+  client.me(:show)
+```
+
+If you have multiple applications or you just want to ve explicit use the application credentials inside the session creation
+
+```Ruby
+  session = RedboothRuby::Session.new(
+    token: '_your_user_token_',
+    consumer_key: '_your_app_key_',
+    consumer_secret: '_your_app_secret'
+  )
+  client = RedboothRuby::Client.new(session)
+```
+
+Async Endpoints
+======
+
+Redbooth API is ready to transform any endpoint to async performing in order to optimize the API response time. When this happens the response will contain:
+
+* `202` status code
+
+* `Retry-After` header with the time in seconds to wait until retry the same request
+
+To know the real response of this request you just need to perform the same request once the retry-after time passed.
+
+In the client we handle this work for you by waiting and repeating the request if needed, but if you want to perform the retry method in any other way (renqueue the job for instance) you should declare it in the client initialize process:
+
+```Ruby
+client = RedboothRuby::Client.new(session, retry: -> { |time|  YourFancyJob.enque_in(time, params) })
+```
+
+Collections
+======
+
+Index methods always return a `RedboothRuby::Request::Collection` object to handle the pagination and ordering.
+
+ie:
+```Ruby
+tasks_collection = client.task(:index, project_id: 2)
+tasks_collection.class # => RedboothRuby::Request::Collection
+tasks = tasks_collection.all
+
+tasks_collection.current_page # => 1
+tasks_collection.total_pages # => 7
+tasks_collection.per_page # => 30
+tasks_collection.count # => 208
+
+next_page_collection = tasks_collection.next_page
+next_page_collection.class # => RedboothRuby::Request::Collection
+
+prev_page_collection = tasks_collection.prev_page
+prev_page_collection.class # => RedboothRuby::Request::Collection
+```
+
+## Collection Methods
+
+* `all` :  `Array` of elements in the current page
+
+* `count` :  `Integer` number of the total elements
+
+* `current_page`: `Integer` current page number (nil if the resource is not paginated)
+
+* `total_pages`: `Integer` total pages number (nil if the resource is not paginated)
+
+* `next_page`: `RedboothRuby::Request::Collection` Collection object pointing to the next page (nil if the resource is not paginated or there is no next page)
+
+* `prev_page`: `RedboothRuby::Request::Collection` Collection object pointing to the prev page (nil if the resource is not paginated or there is no next page)
+
+## Examples
+
+Iterating thought all the pages
+
+```Ruby
+tasks_collection = client.task(:index, project_id: 2)
+tasks = tasks_collection.all
+
+while task_collection = tasks_collection.next_page do
+  tasks << task_collection.all
+end
+
+tasks.flatten!
+```
+
+Users
+=====
+
+List users in your network
+
+```Ruby
+  users_collection = client.user(:index)
+  users = users_collection.all
+```
+
+Fetch a especific user
+
+```Ruby
+  user = client.user(:show, id: 123)
+```
+
+Tasks
+=====
+
+Lists tasks in your visibility scope
+
+```Ruby
+  tasks_collection = client.task(:index)
+  tasks = tasks_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:tasks,header:tasks-task-list) )
+
+```Ruby
+  filtered_tasks = client.task(:index, order: 'id-DESC',
+                                        per_page: 50,
+                                        project_id: 123)
+```
+
+Fetch a especific task
+
+```Ruby
+  task = client.task(:show, id: 123)
+```
+
+Update a especific task
+
+```Ruby
+  task = client.task(:update, id: 123, name: 'new name')
+```
+
+Delete a especific task
+
+```Ruby
+  client.task(:delete, id: 123)
+```
+
+Organizations
+=====
+
+Lists organizations in your visibility scope
+
+```Ruby
+  organization_collection = client.organization(:index)
+  organizations = organization_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:organizations,header:organizations-organization-list) )
+
+```Ruby
+  filtered_organizations = client.organization(:index, order: 'id-DESC',
+                                                       per_page: 50)
+```
+
+Fetch a especific organization
+
+```Ruby
+  organization = client.organization(:show, id: 123)
+```
+
+Create a organization
+
+```Ruby
+  organization = client.organization(:create, name: 'New Organization')
+```
+
+Update a especific organization
+
+```Ruby
+  organization = client.organization(:update, id: 123, name: 'new name')
+```
+
+Delete a especific organization
+
+```Ruby
+  client.organization(:delete, id: 123)
+```
+
+Projects
+=====
+
+Lists projects in your visibility scope
+
+```Ruby
+  project_collection = client.project(:index)
+  projects = project_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:projects,header:projects-project-list) )
+
+```Ruby
+  filtered_projects = client.project(:index, order: 'id-DESC',
+                                                       per_page: 50)
+```
+
+Fetch a especific project
+
+```Ruby
+  project = client.project(:show, id: 123)
+```
+
+Create a project
+
+```Ruby
+  project = client.project(:create, name: 'New Project')
+```
+
+Update a especific project
+
+```Ruby
+  project = client.project(:update, id: 123, name: 'new name')
+```
+
+Delete a especific project
+
+```Ruby
+  client.project(:delete, id: 123)
+```
+
+People
+=====
+
+People is the redbooth relation between projects and users containing the role
+information
+
+```
+|-------|         |--------|         |---------|
+| User  |   ==>   | Person |   ==>   | Project |
+|-------|         |--------|         |---------|
+                      \
+                    {role}
+```
+
+Lists People in your visibility scope
+
+```Ruby
+  people_collection = client.person(:index)
+  people = people_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:people,header:people-people-list) )
+
+```Ruby
+  filtered_people = client.person(:index, order: 'id-DESC',
+                                          per_page: 50)
+```
+
+Fetch a especific person
+
+```Ruby
+  people = client.person(:show, id: 123)
+```
+
+Create a person
+
+```Ruby
+  person = client.person(:create, project_id: 123, user_id: 123, role: 'participant')
+```
+
+Update a especific person
+
+```Ruby
+  person = client.person(:update, id: 123, role: 'admin')
+```
+
+Delete a especific person
+
+```Ruby
+  client.person(:delete, id: 123)
+```
+
+Memberships
+=====
+
+Memberships is the redbooth relation between organization and users containing the role information
+
+```
+|-------|         |------------|         |--------------|
+| User  |   ==>   | Membership |   ==>   | Organization |
+|-------|         |------------|         |--------------|
+                      \
+                    {role}
+```
+
+Lists Memberships in your visibility scope
+
+```Ruby
+  membership_collection = client.membership(:index)
+  memberships = membership_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:memberships,header:memberships-memberships-list) )
+
+```Ruby
+  filtered_memberships = client.membership(:index, order: 'id-DESC',
+                                                   per_page: 50)
+```
+
+Fetch a especific membership
+
+```Ruby
+  memberships = client.membership(:show, id: 123)
+```
+
+Create a membership
+
+```Ruby
+  membership = client.membership(:create, organization_id: 123, user_id: 123, role: 'participant')
+```
+
+Update a especific membership
+
+```Ruby
+  membership = client.membership(:update, id: 123, role: 'admin')
+```
+
+Delete a especific membership
+
+```Ruby
+  client.membership(:delete, id: 123)
+```
+
+Conversations
+=====
+
+Lists conversations in your visibility scope
+
+```Ruby
+  conversation_collection = client.conversation(:index)
+  conversations = conversation_collection.all
+```
+
+You can also filter by multiple params (see docs [here](https://redbooth.com/api/api-docs/#page:conversations,header:conversations-conversations-list) )
+
+```Ruby
+  filtered_conversations = client.conversation(:index, order: 'id-DESC',
+                                                       per_page: 50,
+                                                       project_id: 123)
+```
+
+Fetch a especific conversation
+
+```Ruby
+  conversation = client.conversation(:show, id: 123)
+```
+
+Update a especific conversation
+
+```Ruby
+  conversation = client.conversation(:update, id: 123, name: 'new name')
+```
+
+Delete a especific conversation
+
+```Ruby
+  client.conversation(:delete, id: 123)
+```
+
+License
+=====
+
+Copyright (c) 2012-2013 Redbooth. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task default: :spec

data/lib/redbooth-ruby/base.rb

@@ -0,0 +1,43 @@
+module RedboothRuby
+  class Base
+    include RedboothRuby::Operations::Base
+
+    attr_accessor :created_time
+
+    # Initializes the object using the given attributes
+    #
+    # @param [Hash] attributes The attributes to use for initialization
+    def initialize(attributes = {})
+      set_attributes(attributes)
+      parse_timestamps
+    end
+
+    # Model validations
+    #
+    # @return [Boolean]
+    def valid?
+      errors.empty?
+    end
+
+    # Accesor for the errors
+    #
+    def errors
+      @errors || []
+    end
+
+    # Sets the attributes
+    #
+    # @param [Hash] attributes The attributes to initialize
+    def set_attributes(attributes)
+      attributes.each_pair do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    # Parses UNIX timestamps and creates Time objects.
+    def parse_timestamps
+      @created_time = created_time.to_i if created_time.is_a? String
+      @created_time = Time.at(created_time) if created_time
+    end
+  end
+end

data/lib/redbooth-ruby/client.rb

@@ -0,0 +1,85 @@
+module RedboothRuby
+  class Client
+    RESOURCES = [:me, :user, :task, :organization, :person, :project, :conversation, :membership]
+
+    attr_reader :session, :options
+
+    # Creates an client object using the given Redbooth session.
+    # existing account.
+    #
+    # @param [String] client object to use the redbooth api.
+    def initialize(session, options={})
+      raise RedboothRuby::AuthenticationError unless session.valid?
+      @session = session
+      @options = options
+      self
+    end
+
+    # Metaprograming of every resource to execute it over the perform!
+    # method just to add session tho the resource
+    #
+    # @param [String||Symbol] action name of the action to execute over
+    # @param [Hash] options for the execution
+    # @returns the execution return or nil
+    #
+    # @example
+    #   session = RedboothRuby::Session.new(api_key: '_your_api_key_', auth_token: '_aut_token_for_the_user')
+    #   client = RedboothRuby::Client.new(session)
+    #   client.user.show # returns user profile
+    #   client.files.all
+    #
+    RESOURCES.each do |resource|
+      eval %{
+        def #{resource.to_s}(action, options={})
+          perform!(:#{resource.to_s}, action, options)
+        end
+      }
+    end
+
+    protected
+
+    # Executes block with the access token
+    #
+    # @param [String||Symbol] resource_name name of the resource to execute over
+    # @param [String||Symbol] action name of the action to execute over
+    # @param [Hash] options for the execution
+    # @returns the execution return or nil
+    def perform!(resource_name, action, options = {})
+      fail RedboothRuby::AuthenticationError unless session
+      resource(resource_name).send(action, options_with_session(options))
+    rescue Processing => processing
+      delay = processing.response.data["retry_after"] || 10
+      retry_in(delay, resource_name, action, options)
+    end
+
+    # Retryes the request in the given time
+    # either calls the given proc options[:retry]
+    # or executes it in this thread
+    #
+    def retry_in(delay, *args)
+      if options[:retry]
+        options[:retry].call(delay)
+      else
+        sleep(delay)
+        perform!(*args)
+      end
+    end
+
+    # Merge the given options with the session for use the api
+    #
+    # @param [Hash] options options to merge with session
+    # @return [Hash]
+    def options_with_session(options={})
+      options.merge(session: @session)
+    end
+
+    # Gest the api resource model class by his name
+    #
+    # @param [String||Symbol] name name of the resource
+    # @return [Copy::Base] resource to use the api
+    def resource(name)
+      eval('RedboothRuby::' + name.to_s.capitalize) rescue nil
+    end
+
+  end
+end

data/lib/redbooth-ruby/conversation.rb

@@ -0,0 +1,20 @@
+module RedboothRuby
+  class Conversation < 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,
+                  :project_id,
+                  :user_id,
+                  :comments_count,
+                  :is_private,
+                  :last_activity_id,
+                  :created_at,
+                  :updated_at
+
+  end
+end

data/lib/redbooth-ruby/me.rb

@@ -0,0 +1,16 @@
+module RedboothRuby
+  class Me < Base
+    include RedboothRuby::Operations::Show
+    include RedboothRuby::Operations::Update
+    include RedboothRuby::Operations::Delete
+
+    attr_accessor :id, :email, :first_name, :last_name
+
+    class << self
+      def api_member_url(id = nil, method = nil)
+        'me'
+      end
+    end
+
+  end
+end

data/lib/redbooth-ruby/membership.rb

@@ -0,0 +1,17 @@
+module RedboothRuby
+  class Membership < Base
+    include RedboothRuby::Operations::Index
+    include RedboothRuby::Operations::Create
+    include RedboothRuby::Operations::Update
+    include RedboothRuby::Operations::Show
+    include RedboothRuby::Operations::Delete
+
+    attr_accessor :id,
+                  :user_id,
+                  :organization_id,
+                  :role,
+                  :created_at,
+                  :updated_at
+
+  end
+end