clubhouse.io-ruby 0.1.0

data/lib/clubhouse/client.rb

@@ -0,0 +1,83 @@
+module Clubhouse
+  class BadRequestError < StandardError; end
+  class UnauthorizedError < StandardError; end
+  class ResourceNotFoundError < StandardError; end
+  class UnexpectedError < StandardError; end
+  class UnprocessableError < StandardError; end
+
+  class Client
+    include APIActions
+
+    API_VERSION='v1'.freeze
+
+    def initialize(token)
+      @token = token
+    end
+
+    def basepath
+      @basepath ||= "https://api.clubhouse.io/api/#{API_VERSION}"
+    end
+
+    def get(resource)
+      req = Net::HTTP::Get.new(build_uri(resource))
+      do_request(req)
+    end
+
+    def delete(resource)
+      req = Net::HTTP::Delete.new(build_uri(resource))
+      do_request(req)
+    end
+
+    def post(resource, body = {})
+      req = Net::HTTP::Post.new(build_uri(resource))
+      req['Content-Type'] = 'application/json'
+      req.body = body.to_json
+
+      do_request(req)
+    end
+
+    def put(resource, body = {})
+      req = Net::HTTP::Put.new(build_uri(resource))
+      req['Content-Type'] = 'application/json'
+      req.body = body.to_json
+
+      do_request(req)
+    end
+
+    def raise_error_to_user(response)
+      code = response.code.to_i
+
+      err = case code
+        when 400 then BadRequestError
+        when 401, 403 then UnauthorizedError
+        when 404 then ResourceNotFoundError
+        when 422 then UnprocessableError
+        else UnexpectedError
+      end
+
+      raise err, response.body
+    end
+
+    private
+
+    def build_uri(resource)
+      uri = URI.parse("#{basepath}/#{resource}")
+      uri.query = URI.encode_www_form(token: @token)
+      uri
+    end
+
+    def do_request(request)
+      http = Net::HTTP.new(request.uri.host, request.uri.port)
+      http.use_ssl = true
+      response = http.request(request)
+
+      if [200,201,204].include?(response.code.to_i)
+        # Clubhouse API returns content type as application/json for DELETE request with no body :(
+        return {} if response.body.nil?
+        JSON.parse(response.body)
+      else
+        raise_error_to_user(response)
+      end
+    end
+  end
+end

data/lib/clubhouse/comment.rb

@@ -0,0 +1,45 @@
+module Clubhouse
+  class Comment < BaseResource
+    resource :comments
+
+    attributes :author_id, :created_at, :external_id, :story_id, :text, :updated_at,
+      readonly: [:id, :mention_ids, :position]
+
+    attributes_for_create :author_id, :created_at, :external_id, :text, :updated_at
+    attributes_for_update :text
+
+    def save
+      raise MissingStoryIDError, 'story_id is required to create/update comments' unless story_id
+      raise ClientNotSetup, "A default client or instance client is not setup" unless client
+
+      payload = if id
+                  client.put("stories/#{story_id}/#{self.class.endpoint}/#{id}", update_attributes)
+                else
+                  client.post("stories/#{story_id}/#{self.class.endpoint}", create_attributes)
+                end
+
+      update_object_from_payload(payload)
+    end
+
+    def reload
+      payload = client.get("stories/#{story_id}/#{self.class.endpoint}/#{id}")
+      update_object_from_payload(payload)
+    end
+
+    class << self
+      def find(story_id, comment_id)
+        payload = client.get("stories/#{story_id}/#{endpoint}/#{comment_id}")
+        new.update_object_from_payload(payload)
+      end
+
+      def delete(story_id, comment_id)
+        client.delete("stories/#{story_id}/#{endpoint}/#{comment_id}")
+      end
+
+      def all
+        raise NotSupportedByAPIError,
+          "You can get all comments associated directly from the story model"
+      end
+    end
+  end
+end

data/lib/clubhouse/epic.rb

@@ -0,0 +1,38 @@
+module Clubhouse
+  class Epic < BaseResource
+    resource :epics
+
+    attributes :archived, :created_at, :deadline, :description, :external_id,
+      :follower_ids, :name, :owner_ids, :state, :updated_at, readonly: [:id, :comments, :position]
+
+    attributes_for_create :created_at, :deadline, :description, :external_id,
+      :follower_ids, :name, :owner_ids, :state, :updated_at
+
+    attributes_for_update :after_id, :archived, :before_id, :deadline,
+      :description, :follower_ids, :name, :owner_ids, :state
+
+    def comments
+      @_comments ||= Array(@comments).collect{|c| Comment.new.update_object_from_payload(c) }
+    end
+
+    class Comment < BaseResource
+      attributes :text, readonly: [:author_id, :created_at, :updated_at, :deleted, :id, :comments]
+
+      def comments
+        @_comments ||= Array(@comments).collect {|c| Comment.new.update_object_from_payload(c) }
+      end
+
+      def save
+        raise NotImplemented
+      end
+
+      def self.find(id = nil)
+        raise NotImplemented
+      end
+
+      def self.all
+        raise NotImplemented
+      end
+    end
+  end
+end

data/lib/clubhouse/ext/string.rb

@@ -0,0 +1,9 @@
+class String
+  def underscore
+    self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+end

data/lib/clubhouse/file.rb

@@ -0,0 +1,19 @@
+module Clubhouse
+  class File < BaseResource
+    resource :files
+
+    attributes :created_at, :description, :external_id, :name, :updated_at, :uploader_id,
+      readonly: [:content_type, :filename, :id, :mention_ids, :size, :story_ids, :thumbnail_url, :url]
+
+    attributes_for_update :description, :external_id, :name, :updated_at, :uploader_id
+
+    def save
+      if id.nil?
+        raise NotSupportedByAPIError,
+          "You can't create a direct file upload, but can create linked files over the API"
+      end
+
+      super
+    end
+  end
+end

data/lib/clubhouse/label.rb

@@ -0,0 +1,18 @@
+module Clubhouse
+  class Label < BaseResource
+    resource :labels
+
+    attributes :name, :external_id, readonly: [
+      :id,
+      :num_stories_in_progress,
+      :num_stories_total,
+      :num_stories_completed,
+      :created_at,
+      :updated_at,
+      :num_stories_completed
+    ]
+
+    attributes_for_create :name, :external_id
+    attributes_for_update :name
+  end
+end

data/lib/clubhouse/linked_file.rb

@@ -0,0 +1,13 @@
+module Clubhouse
+  class LinkedFile < BaseResource
+    resource 'linked-files'
+
+    attributes :content_type, :description, :name, :size, :story_id, :thumbnail_url,
+      :uploader_id, :url, :type, readonly: [:created_at, :id, :mention_ids, :story_ids, :updated_at]
+
+    attributes_for_create :content_type, :description, :name, :size, :story_id,
+      :thumbnail_url, :type, :uploader_id, :url
+
+    attributes_for_update :description, :name, :size, :thumbnail_url, :type, :uploader_id, :url
+  end
+end

data/lib/clubhouse/project.rb

@@ -0,0 +1,20 @@
+module Clubhouse
+  class Project < BaseResource
+    resource :projects
+
+    attributes :abbreviation, :archived, :color, :created_at, :description, :external_id,
+      :follower_ids, :name, :updated_at, readonly: [:archived, :id, :num_points, :num_stories]
+
+    attributes_for_create :abbreviation, :color, :created_at, :description,
+      :external_id, :follower_ids, :name, :updated_at
+
+    attributes_for_update :abbreviation, :archived, :color, :description, :follower_ids, :name
+
+    def stories
+      return [] if id.nil?
+
+      payload = client.get("projects/#{id}/stories")
+      Array(payload).collect{|s| Story.new.update_object_from_payload(s) }
+    end
+  end
+end

data/lib/clubhouse/story.rb

@@ -0,0 +1,70 @@
+module Clubhouse
+  class Story < BaseResource
+    resource :stories
+
+    attributes :archived, :comments, :created_at, :deadline, :description, :epic_id, :estimate,
+      :file_ids, :follower_ids, :labels, :linked_file_ids, :name, :owner_ids,
+      :position, :project_id, :requested_by_id, :story_links, :story_type, :tasks,
+      :updated_at, :workflow_state_id, readonly: :id
+
+    attributes_for_create :comments, :created_at, :deadline, :description, :epic_id, :estimate,
+                          :external_id, :file_ids, :labels, :linked_file_ids, :name, :owner_ids,
+                          :project_id, :requested_by_id, :story_links, :story_type, :tasks,
+                          :updated_at, :workflow_state_id
+
+    attributes_for_update :after_id, :archived, :before_id, :deadline, :description, :epic_id,
+                          :estimate, :file_ids, :follower_ids, :labels, :linked_file_ids, :name,
+                          :owner_ids, :project_id, :requested_by_id, :story_type, :workflow_state_id
+
+
+    def comments
+      @_comments ||= Array(@comments).collect {|c| Comment.new.update_object_from_payload(c) }
+    end
+
+    def tasks
+      @_tasks ||= Array(@tasks).collect {|t| Task.new.update_object_from_payload(t) }
+    end
+
+    def add_comment(text)
+      add_resource(:comment) do
+        comment = Comment.new(text: text, story_id: id)
+        comment.save
+        comments << comment
+      end
+    end
+
+    def add_task(desc)
+      add_resource(:task) do
+        task = Task.new(description: desc, story_id: id)
+        task.save
+        tasks << task
+      end
+    end
+
+    def update_object_from_payload(attr = {})
+      super
+      instance_variable_set("@_comments", nil)
+      instance_variable_set("@_tasks", nil)
+      self
+    end
+
+    class << self
+      def all
+        raise NotSupportedByAPIError,
+          'Use Story.search(..) to return stories matching your search query'
+      end
+
+      def search(attr = {})
+        payload = client.post("#{endpoint}/search", attr)
+        payload.collect {|s| new.update_object_from_payload(s) }
+      end
+    end
+
+    private
+
+    def add_resource(type)
+      raise StoryNotSavedError, "Please save the story to use the add #{type} method" unless id
+      yield
+    end
+  end
+end

data/lib/clubhouse/story_link.rb

@@ -0,0 +1,17 @@
+module Clubhouse
+  class StoryLink < BaseResource
+    resource 'story-links'
+
+    attributes :object_id, :subject_id, :verb, readonly: [ :created_at, :id, :updated_at ]
+    attributes_for_create :object_id, :subject_id, :verb
+
+    def save
+      raise NotSupportedByAPIError, "You can't update a story link" if id
+      super
+    end
+
+    def self.all
+      raise NotSupportedByAPIError, "Not supported by the API"
+    end
+  end
+end

data/lib/clubhouse/task.rb

@@ -0,0 +1,45 @@
+module Clubhouse
+  class Task < BaseResource
+    resource :tasks
+
+    attributes :complete, :created_at, :description, :external_id, :owner_ids,
+      :updated_at, :story_id, readonly: [:completed_at, :id, :mention_ids, :position]
+
+    attributes_for_create :complete, :created_at, :description, :external_id, :owner_ids, :updated_at
+    attributes_for_update :after_id, :before_id, :complete, :description, :owner_ids
+
+
+    def save
+      raise MissingStoryIDError, 'story_id is required to create/update tasks' unless story_id
+      raise ClientNotSetup, "A default client or instance client is not setup" unless client
+
+      payload = if id
+                  client.put("stories/#{story_id}/#{self.class.endpoint}/#{id}", update_attributes)
+                else
+                  client.post("stories/#{story_id}/#{self.class.endpoint}", create_attributes)
+                end
+
+      update_object_from_payload(payload)
+    end
+
+    def reload
+      payload = client.get("stories/#{story_id}/#{self.class.endpoint}/#{id}")
+      update_object_from_payload(payload)
+    end
+
+    class << self
+      def find(story_id, task_id)
+        payload = client.get("stories/#{story_id}/#{endpoint}/#{task_id}")
+        new.update_object_from_payload(payload)
+      end
+
+      def delete(story_id, task_id)
+        client.delete("stories/#{story_id}/tasks/#{task_id}")
+      end
+
+      def all
+        raise NotSupportedByAPIError, "You can get all tasks associated directly from the story model"
+      end
+    end
+  end
+end

data/lib/clubhouse/user.rb

@@ -0,0 +1,34 @@
+module Clubhouse
+  class User < BaseResource
+    resource :users
+
+    attributes :name, readonly: [ :deactivated, :id, :name, :permissions,
+                                  :two_factor_auth_activated, :username]
+
+    Permission = Struct.new(:created_at, :disabled, :email_address,
+                            :gravatar_hash, :id, :initials, :role, :updated_at)
+
+    def save
+      raise NotSupportedByAPIError, "You can't create users over the API, please use clubhouse web"
+    end
+
+    def self.delete(id = nil)
+      raise NotSupportedByAPIError, "You can't delete users over the API, please use clubhouse web"
+    end
+
+    def permissions
+      @_permissions ||= Array(@permissions).collect do |p|
+        Permission.new(
+          p['created_at'],
+          p['disabled'],
+          p['email_address'],
+          p['gravatar_hash'],
+          p['id'],
+          p['initials'],
+          p['role'],
+          p['updated_at']
+        )
+      end
+    end
+  end
+end

data/lib/clubhouse/version.rb

@@ -0,0 +1,3 @@
+module Clubhouse
+  VERSION = "0.1.0"
+end

data/lib/clubhouse/workflow.rb

@@ -0,0 +1,42 @@
+module Clubhouse
+  class Workflow < BaseResource
+    resource :workflows
+
+    attributes :default_state_id, readonly: [:id, :created_at, :states, :updated_at]
+
+    State = Struct.new(:color, :created_at, :description, :id, :name,
+                        :num_stories, :position, :type, :updated_at, :verb)
+
+    def save
+      raise NotSupportedByAPIError,
+        "You can't manage workflows over the API, please use clubhouse web"
+    end
+
+    def self.delete(id = nil)
+      raise NotSupportedByAPIError,
+        "You can't delete workflows over the API, please use clubhouse web"
+    end
+
+    def self.find(id = nil)
+      raise NotSupportedByAPIError,
+        "You can only list all workflows, please use Clubhouse::Workflow.all"
+    end
+
+    def states
+      @_states ||= Array(@states).collect do |s|
+        State.new(
+          s['color'],
+          s['created_at'],
+          s['description'],
+          s['id'],
+          s['name'],
+          s['num_stories'],
+          s['position'],
+          s['type'],
+          s['updated_at'],
+          s['verb']
+        )
+      end
+    end
+  end
+end