basecamp3 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 25d907fca510e039fabfd3250013637c7d800246
+  data.tar.gz: c5edc62e7674fc10be160f26464e30d09e7cdedb
+SHA512:
+  metadata.gz: d4802fd3ca6ecc7678f94e329cdc399ae67b8c47dcb52dfc1864a86fd6948403cc5a13a3e16f68341d7c2e05e3d0c2a8c23a3bf59ab0044b8ad96c8d6085a757
+  data.tar.gz: 06f465c38773e80de1668006da2a7e36aced8aab17a276a14b6207807f28b116476f2e65010e47b9150aae5969ca84dfb0ecee11eadf44561e44b1a055542f36

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.idea
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 goth-pl
+
+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,65 @@
+# Basecamp3 API Wrapper
+
+A simple Ruby Wrapper for the Basecamp3 API.
+
+[For more information about Basecamp3 API, see the official documentation](https://github.com/basecamp/bc3-api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'basecamp3'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install basecamp3
+
+## Basic usage
+
+First, you have to establish a connection to Basecamp3. If you don't know how to get the access token, [see the official authentication guide](https://github.com/basecamp/api/blob/master/sections/authentication.md)
+
+    Basecamp3.connect(YOUR_BASECAMP3_ACCOUNT_ID, YOUR_BASECAMP3_ACCESS_TOKEN)
+
+That's all. You can make requests now. 
+
+E.g.: to get the TODO, just call the `find` method from the `Basecamp3::Todo` class:
+
+    todo = Basecamp3::Todo.find(BUCKET_ID, TODO_ID)
+    todo.content # = 'Hello world!'
+
+## Documentation
+
+For the full documentation go [here](https://miastologia.github.io/basecamp3-api-wrapper/).
+
+## TODO
+
+### Missing models
+* Attachments
+* Chatbots
+* Client approvals
+* Client correspondences
+* Client replies
+* Events
+* Recordings
+* Templates
+* Uploads
+* Webhooks
+
+### Other
+* updating Basecamp data directly from a model instance (something like `save` method)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/miastologia/basecamp3-api-wrapper.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/basecamp3.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'basecamp3/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "basecamp3"
+  spec.version = Basecamp3::VERSION
+  spec.authors = ["goth-pl"]
+  spec.email = ["m.szycko@gmail.com"]
+
+  spec.summary = %q{Basecamp3 API Wrapper}
+  spec.description = %q{A simple Ruby Wrapper for the Basecamp 3 API}
+  spec.homepage = "https://github.com/miastologia/basecamp3-api-wrapper"
+  spec.license = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "yard", "~> 0.9.9"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "basecamp3"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docs/Basecamp3.html

@@ -0,0 +1,367 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: Basecamp3
+  
+    &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 = "Basecamp3";
+  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 (B)</a> &raquo;
+    
+    
+    <span class="title">Basecamp3</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>Module: Basecamp3
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/basecamp3/concerns/bucketable.rb<span class="defines">,<br />
+  lib/basecamp3.rb,<br /> lib/basecamp3/version.rb,<br /> lib/basecamp3/concerns/parentable.rb,<br /> lib/basecamp3/concerns/commentable.rb,<br /> lib/basecamp3/concerns/creatorable.rb,<br /> lib/basecamp3/concerns/recordingable.rb</span>
+</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>A concern for recordingable models</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Basecamp3/Concerns.html" title="Basecamp3::Concerns (module)">Concerns</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Basecamp3/Campfire.html" title="Basecamp3::Campfire (class)">Campfire</a></span>, <span class='object_link'><a href="Basecamp3/CampfireLine.html" title="Basecamp3::CampfireLine (class)">CampfireLine</a></span>, <span class='object_link'><a href="Basecamp3/Comment.html" title="Basecamp3::Comment (class)">Comment</a></span>, <span class='object_link'><a href="Basecamp3/Document.html" title="Basecamp3::Document (class)">Document</a></span>, <span class='object_link'><a href="Basecamp3/Forward.html" title="Basecamp3::Forward (class)">Forward</a></span>, <span class='object_link'><a href="Basecamp3/Inbox.html" title="Basecamp3::Inbox (class)">Inbox</a></span>, <span class='object_link'><a href="Basecamp3/Message.html" title="Basecamp3::Message (class)">Message</a></span>, <span class='object_link'><a href="Basecamp3/MessageBoard.html" title="Basecamp3::MessageBoard (class)">MessageBoard</a></span>, <span class='object_link'><a href="Basecamp3/MessageType.html" title="Basecamp3::MessageType (class)">MessageType</a></span>, <span class='object_link'><a href="Basecamp3/Model.html" title="Basecamp3::Model (class)">Model</a></span>, <span class='object_link'><a href="Basecamp3/Person.html" title="Basecamp3::Person (class)">Person</a></span>, <span class='object_link'><a href="Basecamp3/Project.html" title="Basecamp3::Project (class)">Project</a></span>, <span class='object_link'><a href="Basecamp3/Question.html" title="Basecamp3::Question (class)">Question</a></span>, <span class='object_link'><a href="Basecamp3/QuestionAnswer.html" title="Basecamp3::QuestionAnswer (class)">QuestionAnswer</a></span>, <span class='object_link'><a href="Basecamp3/Questionnaire.html" title="Basecamp3::Questionnaire (class)">Questionnaire</a></span>, <span class='object_link'><a href="Basecamp3/Request.html" title="Basecamp3::Request (class)">Request</a></span>, <span class='object_link'><a href="Basecamp3/ResponseParser.html" title="Basecamp3::ResponseParser (class)">ResponseParser</a></span>, <span class='object_link'><a href="Basecamp3/Schedule.html" title="Basecamp3::Schedule (class)">Schedule</a></span>, <span class='object_link'><a href="Basecamp3/ScheduleEntry.html" title="Basecamp3::ScheduleEntry (class)">ScheduleEntry</a></span>, <span class='object_link'><a href="Basecamp3/Todo.html" title="Basecamp3::Todo (class)">Todo</a></span>, <span class='object_link'><a href="Basecamp3/TodoList.html" title="Basecamp3::TodoList (class)">TodoList</a></span>, <span class='object_link'><a href="Basecamp3/TodoSet.html" title="Basecamp3::TodoSet (class)">TodoSet</a></span>, <span class='object_link'><a href="Basecamp3/TypeMapper.html" title="Basecamp3::TypeMapper (class)">TypeMapper</a></span>, <span class='object_link'><a href="Basecamp3/Vault.html" title="Basecamp3::Vault (class)">Vault</a></span>
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  <dl class="constants">
+    
+      <dt id="HOST-constant" class="">HOST =
+        
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>https://3.basecampapi.com</span><span class='tstring_end'>&#39;</span></span></pre></dd>
+    
+      <dt id="VERSION-constant" class="">VERSION =
+        
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+    
+  </dl>
+
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#connect-class_method" title="connect (class method)">.<strong>connect</strong>(account_id, access_token)  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Establishes a connection with basecamp.</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#request-class_method" title="request (class method)">.<strong>request</strong>  &#x21d2; Basecamp3::Request </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the request object.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="connect-class_method">
+  
+    .<strong>connect</strong>(account_id, access_token)  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Establishes a connection with basecamp</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>account_id</span>
+      
+      
+        <span class='type'>(<tt>Integer</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the id of your basecamp account</p>
+</div>
+      
+    </li>
+  
+    <li>
+      
+        <span class='name'>access_token</span>
+      
+      
+        <span class='type'>(<tt>Integer</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>the oauth2 access token</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+45
+46
+47
+48
+49
+50
+51</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/basecamp3.rb', line 45</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_connect'>connect</span><span class='lparen'>(</span><span class='id identifier rubyid_account_id'>account_id</span><span class='comma'>,</span> <span class='id identifier rubyid_access_token'>access_token</span><span class='rparen'>)</span>
+  <span class='ivar'>@account_id</span> <span class='op'>=</span> <span class='id identifier rubyid_account_id'>account_id</span>
+  <span class='ivar'>@access_token</span> <span class='op'>=</span> <span class='id identifier rubyid_access_token'>access_token</span>
+  <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#HOST-constant" title="Basecamp3::HOST (constant)">HOST</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='ivar'>@account_id</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
+
+  <span class='ivar'>@request</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Basecamp3 (module)">Basecamp3</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Basecamp3/Request.html" title="Basecamp3::Request (class)">Request</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Basecamp3/Request.html#initialize-instance_method" title="Basecamp3::Request#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@access_token</span><span class='comma'>,</span> <span class='ivar'>@uri</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="request-class_method">
+  
+    .<strong>request</strong>  &#x21d2; <tt><span class='object_link'><a href="Basecamp3/Request.html" title="Basecamp3::Request (class)">Basecamp3::Request</a></span></tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the request object</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt><span class='object_link'><a href="Basecamp3/Request.html" title="Basecamp3::Request (class)">Basecamp3::Request</a></span></tt>)</span>
+      
+      
+      
+    </li>
+  
+</ul>
+<p class="tag_title">Raises:</p>
+<ul class="raise">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>StandardError</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>raises an error if a connection is not established</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+57
+58
+59</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/basecamp3.rb', line 57</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_request'>request</span>
+  <span class='ivar'>@request</span> <span class='op'>||</span> <span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>You have to call Basecamp.connect method first</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</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>