RubyGems - basecamp3 - Versions diffs - 0.1.3 - Mend

basecamp3 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (89) hide show

checksums.yaml +7 -0
data/.gitignore +12 -0
data/.rspec +2 -0
data/.travis.yml +5 -0
data/Gemfile +2 -0
data/LICENSE.txt +21 -0
data/README.md +65 -0
data/Rakefile +6 -0
data/basecamp3.gemspec +38 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/docs/Basecamp3.html +367 -0
data/docs/Basecamp3/Campfire.html +901 -0
data/docs/Basecamp3/CampfireLine.html +1025 -0
data/docs/Basecamp3/Comment.html +1284 -0
data/docs/Basecamp3/Concerns.html +117 -0
data/docs/Basecamp3/Concerns/Bucketable.html +211 -0
data/docs/Basecamp3/Concerns/Commentable.html +285 -0
data/docs/Basecamp3/Concerns/Creatorable.html +209 -0
data/docs/Basecamp3/Concerns/Parentable.html +211 -0
data/docs/Basecamp3/Concerns/Recordingable.html +189 -0
data/docs/Basecamp3/Concerns/Recordingable/ClassMethods.html +236 -0
data/docs/Basecamp3/Document.html +1262 -0
data/docs/Basecamp3/Forward.html +1070 -0
data/docs/Basecamp3/Inbox.html +840 -0
data/docs/Basecamp3/Message.html +1262 -0
data/docs/Basecamp3/MessageBoard.html +840 -0
data/docs/Basecamp3/MessageType.html +1160 -0
data/docs/Basecamp3/Model.html +236 -0
data/docs/Basecamp3/Person.html +1288 -0
data/docs/Basecamp3/Project.html +1280 -0
data/docs/Basecamp3/Question.html +1050 -0
data/docs/Basecamp3/QuestionAnswer.html +887 -0
data/docs/Basecamp3/Questionnaire.html +840 -0
data/docs/Basecamp3/Request.html +933 -0
data/docs/Basecamp3/ResponseParser.html +303 -0
data/docs/Basecamp3/Schedule.html +840 -0
data/docs/Basecamp3/ScheduleEntry.html +1560 -0
data/docs/Basecamp3/Todo.html +1726 -0
data/docs/Basecamp3/TodoList.html +1480 -0
data/docs/Basecamp3/TodoSet.html +980 -0
data/docs/Basecamp3/TypeMapper.html +329 -0
data/docs/Basecamp3/Vault.html +1514 -0
data/docs/_index.html +415 -0
data/docs/class_list.html +51 -0
data/docs/css/common.css +1 -0
data/docs/css/full_list.css +58 -0
data/docs/css/style.css +492 -0
data/docs/file.README.html +157 -0
data/docs/file_list.html +56 -0
data/docs/frames.html +17 -0
data/docs/index.html +157 -0
data/docs/js/app.js +248 -0
data/docs/js/full_list.js +216 -0
data/docs/js/jquery.js +4 -0
data/docs/method_list.html +1875 -0
data/docs/top-level-namespace.html +110 -0
data/lib/basecamp3.rb +61 -0
data/lib/basecamp3/concerns/bucketable.rb +17 -0
data/lib/basecamp3/concerns/commentable.rb +15 -0
data/lib/basecamp3/concerns/creatorable.rb +16 -0
data/lib/basecamp3/concerns/parentable.rb +17 -0
data/lib/basecamp3/concerns/recordingable.rb +22 -0
data/lib/basecamp3/model.rb +23 -0
data/lib/basecamp3/models/campfire.rb +42 -0
data/lib/basecamp3/models/campfire_line.rb +52 -0
data/lib/basecamp3/models/comment.rb +65 -0
data/lib/basecamp3/models/document.rb +71 -0
data/lib/basecamp3/models/forward.rb +40 -0
data/lib/basecamp3/models/inbox.rb +31 -0
data/lib/basecamp3/models/message.rb +73 -0
data/lib/basecamp3/models/message_board.rb +31 -0
data/lib/basecamp3/models/message_type.rb +68 -0
data/lib/basecamp3/models/person.rb +46 -0
data/lib/basecamp3/models/project.rb +70 -0
data/lib/basecamp3/models/question.rb +43 -0
data/lib/basecamp3/models/question_answer.rb +35 -0
data/lib/basecamp3/models/questionnaire.rb +31 -0
data/lib/basecamp3/models/schedule.rb +31 -0
data/lib/basecamp3/models/schedule_entry.rb +93 -0
data/lib/basecamp3/models/todo.rb +108 -0
data/lib/basecamp3/models/todo_list.rb +77 -0
data/lib/basecamp3/models/todo_set.rb +33 -0
data/lib/basecamp3/models/vault.rb +79 -0
data/lib/basecamp3/request.rb +163 -0
data/lib/basecamp3/response_parser.rb +44 -0
data/lib/basecamp3/type_mapper.rb +53 -0
data/lib/basecamp3/version.rb +3 -0
metadata +202 -0

data/docs/top-level-namespace.html ADDED

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.9
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Basecamp3.html" title="Basecamp3 (module)">Basecamp3</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Tue May  9 15:32:16 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.9 (ruby-2.2.2).
+</div>
+    </div>
+  </body>
+</html>

data/lib/basecamp3.rb ADDED

@@ -0,0 +1,61 @@
+require 'net/https'
+require 'json'
+require 'basecamp3/version'
+require 'basecamp3/request'
+require 'basecamp3/response_parser'
+require 'basecamp3/type_mapper'
+require 'basecamp3/model'
+require 'basecamp3/concerns/creatorable'
+require 'basecamp3/concerns/bucketable'
+require 'basecamp3/concerns/parentable'
+require 'basecamp3/concerns/recordingable'
+require 'basecamp3/concerns/commentable'
+require 'basecamp3/models/project'
+require 'basecamp3/models/person'
+require 'basecamp3/models/todo_set'
+require 'basecamp3/models/todo_list'
+require 'basecamp3/models/todo'
+require 'basecamp3/models/comment'
+require 'basecamp3/models/vault'
+require 'basecamp3/models/campfire'
+require 'basecamp3/models/campfire_line'
+require 'basecamp3/models/message_board'
+require 'basecamp3/models/message'
+require 'basecamp3/models/message_type'
+require 'basecamp3/models/document'
+require 'basecamp3/models/schedule'
+require 'basecamp3/models/schedule_entry'
+require 'basecamp3/models/question'
+require 'basecamp3/models/question_answer'
+require 'basecamp3/models/questionnaire'
+require 'basecamp3/models/inbox'
+require 'basecamp3/models/forward'
+module Basecamp3
+  class << self
+    HOST = 'https://3.basecampapi.com'
+    # Establishes a connection with basecamp
+    #
+    # @param [Integer] account_id the id of your basecamp account
+    # @param [Integer] access_token the oauth2 access token
+    def connect(account_id, access_token)
+      @account_id = account_id
+      @access_token = access_token
+      @uri = URI.parse("#{HOST}/#{@account_id}")
+      @request = Basecamp3::Request.new(@access_token, @uri)
+    end
+    # Returns the request object
+    #
+    # @return [Basecamp3::Request]
+    # @raise [StandardError] raises an error if a connection is not established
+    def request
+      @request || raise('You have to call Basecamp.connect method first')
+    end
+  end
+end

data/lib/basecamp3/concerns/bucketable.rb ADDED

@@ -0,0 +1,17 @@
+# A concern for bucketable models
+module Basecamp3
+  module Concerns
+    module Bucketable
+      # Returns the related bucket.
+      #
+      # @return [Basecamp3::Model]
+      def bucket
+        return nil if @bucket.nil?
+        klass = TypeMapper.map(@bucket['type'])
+        @mapped_bucket ||= klass.new(@bucket)
+      end
+    end
+  end
+end

data/lib/basecamp3/concerns/commentable.rb ADDED

@@ -0,0 +1,15 @@
+# A concern for commentable models
+module Basecamp3
+  module Concerns
+    module Commentable
+      attr_accessor :comments_count
+      # Returns the related comments.
+      #
+      # @return [Array<Basecamp3::Comment>]
+      def comments
+        @mapped_comments ||= Basecamp3::Comment.all(bucket.id, id)
+      end
+    end
+  end
+end

data/lib/basecamp3/concerns/creatorable.rb ADDED

@@ -0,0 +1,16 @@
+# A concern for creatorable models
+module Basecamp3
+  module Concerns
+    module Creatorable
+      # Returns the creator.
+      #
+      # @return [Basecamp3::Person]
+      def creator
+        return nil if @creator.nil?
+        @mapped_creator ||= Basecamp3::Person.new(@creator)
+      end
+    end
+  end
+end

data/lib/basecamp3/concerns/parentable.rb ADDED

@@ -0,0 +1,17 @@
+# A concern for parentable models
+module Basecamp3
+  module Concerns
+    module Parentable
+      # Returns the parent.
+      #
+      # @return [Basecamp3::Model]
+      def parent
+        return nil if @parent.nil?
+        klass = TypeMapper.map(@parent['type'])
+        @mapped_parent ||= klass.new(@bucket)
+      end
+    end
+  end
+end

data/lib/basecamp3/concerns/recordingable.rb ADDED

@@ -0,0 +1,22 @@
+# A concern for recordingable models
+module Basecamp3
+  module Concerns
+    module Recordingable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+      module ClassMethods
+        # Deletes the record.
+        #
+        # @param [Integer] bucket_id the id of the bucket
+        # @param [Integer] id the id of the record
+        #
+        # @return [Boolean]
+        def delete(bucket_id, id)
+          Basecamp3.request.put("/buckets/#{bucket_id}/recordings/#{id}/status/trashed")
+        end
+      end
+    end
+  end
+end

data/lib/basecamp3/model.rb ADDED

@@ -0,0 +1,23 @@
+# A base class for models
+#
+# @abstract
+class Basecamp3::Model
+  REQUIRED_FIELDS = []
+  def initialize(data = {})
+    data.each do |attr, value|
+      instance_variable_set("@#{attr}", value)
+    end
+  end
+  protected
+  # Validates if the given data contain the required attributes.
+  #
+  # @param [Hash] data the data to send in the request
+  #
+  # @raise [StandardError] raises an error if required parameter is missing
+  def self.validate_required(data)
+    self::REQUIRED_FIELDS.each { |f| raise "Missing required parameter #{f}" if data[f.to_sym].nil? }
+  end
+end

data/lib/basecamp3/models/campfire.rb ADDED

@@ -0,0 +1,42 @@
+# A model for Basecamp's Campfire
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/campfires.md#campfires For more information, see the official Basecamp3 API documentation for Campfires}
+class Basecamp3::Campfire < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :topic
+  REQUIRED_FIELDS = %w(topic)
+  # Returns a list of related lines.
+  #
+  # @return [Array<Basecamp3::CampfireLine>]
+  def lines
+    @mapped_lines ||= Basecamp3::CampfireLine.all(bucket.id, id)
+  end
+  # Returns a paginated list of all active campfires visible to the current user.
+  #
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::Campfire>]
+  def self.all(params = {})
+    Basecamp3.request.get("/chats", params, Basecamp3::Campfire)
+  end
+  # Returns the campfire.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the campfire
+  #
+  # @return [Basecamp3::Campfire]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/chats/#{id}", {}, Basecamp3::Campfire)
+  end
+end

data/lib/basecamp3/models/campfire_line.rb ADDED

@@ -0,0 +1,52 @@
+# A model for Basecamp's CampfireLine
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/campfires.md#campfires For more information, see the official Basecamp3 API documentation for Campfires}
+class Basecamp3::CampfireLine < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  include Basecamp3::Concerns::Parentable
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :content
+  REQUIRED_FIELDS = %w(content)
+  # Returns a paginated list of campfire lines.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the campfire
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::CampfireLine>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/chats/#{parent_id}/lines", params, Basecamp3::CampfireLine)
+  end
+  # Returns the campfire line.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the campfire
+  # @param [Integer] id the id of the campfire line
+  #
+  # @return [Basecamp3::CampfireLine]
+  def self.find(bucket_id, parent_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/chats/#{parent_id}/lines/#{id}", {}, Basecamp3::CampfireLine)
+  end
+  # Creates a campfire line.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the campfire
+  # @param [Hash] data the data to create a campfire line with
+  # @option params [Integer] :content (required) the body of the campfire line
+  #
+  # @return [Basecamp3::CampfireLine]
+  def self.create(bucket_id, parent_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/chats/#{parent_id}/lines", data, Basecamp3::CampfireLine)
+  end
+end

data/lib/basecamp3/models/comment.rb ADDED

@@ -0,0 +1,65 @@
+# A model for Basecamp's Comment
+#
+# {https://github.com/basecamp/bc3-api/blob/master/sections/comments.md#comments For more information, see the official Basecamp3 API documentation for Comments}
+class Basecamp3::Comment < Basecamp3::Model
+  include Basecamp3::Concerns::Creatorable
+  include Basecamp3::Concerns::Bucketable
+  include Basecamp3::Concerns::Parentable
+  include Basecamp3::Concerns::Recordingable
+  attr_accessor :id,
+                :status,
+                :created_at,
+                :updated_at,
+                :content,
+                :parent_id,
+                :bucket_id
+  REQUIRED_FIELDS = %w(content)
+  # Returns a paginated list of active comments.
+  #
+  # @param [Hash] params additional parameters
+  # @option params [Integer] :page (optional) to paginate results
+  #
+  # @return [Array<Basecamp3::Comment>]
+  def self.all(bucket_id, parent_id, params = {})
+    Basecamp3.request.get("/buckets/#{bucket_id}/recordings/#{parent_id}/comments", params, Basecamp3::Comment)
+  end
+  # Returns the comment.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the comment
+  #
+  # @return [Basecamp3::Comment]
+  def self.find(bucket_id, id)
+    Basecamp3.request.get("/buckets/#{bucket_id}/comments/#{id}", {}, Basecamp3::Comment)
+  end
+  # Creates a comment.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] parent_id the id of the parent
+  # @param [Hash] data the data to create a comment with
+  # @option params [String] :content (required) the body of the comment
+  #
+  # @return [Basecamp3::Comment]
+  def self.create(bucket_id, parent_id, data)
+    self.validate_required(data)
+    Basecamp3.request.post("/buckets/#{bucket_id}/recordings/#{parent_id}/comments", data, Basecamp3::Comment)
+  end
+  # Updates the comment.
+  #
+  # @param [Integer] bucket_id the id of the bucket
+  # @param [Integer] id the id of the comment
+  # @param [Hash] data the data to update the comment with
+  # @option params [String] :content (required) the body of the comment
+  #
+  # @return [Basecamp3::Comment]
+  def self.update(bucket_id, id, data)
+    self.validate_required(data)
+    Basecamp3.request.put("/buckets/#{bucket_id}/comments/#{id}", data, Basecamp3::Comment)
+  end
+end