basecamp 0.0.9 → 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a4aed33709e1c506d03f74ea93caa37b20e28f6
+  data.tar.gz: 724ac3904f5e834266ab001891f7bc270fe358f4
+SHA512:
+  metadata.gz: 38d4ff046a943c7e16ca6852cd14ba098505b7ef5a7c1d6a1924433c98dc116b2d9811a398ee3e3b9106220e023251e1d10284864ccb06d82ebbab394440295e
+  data.tar.gz: c795d56445d90fadb6937d3f102ecae247fa4dc0e841f94515070fd64f6ed47d002c027ccd9512a204ae944c4afcf63b0e74e90545234b947f69c162ba8497ea

data/README.rdoc

@@ -43,10 +43,16 @@ requires your Basecamp site address and your login credentials or API token.
 
   Basecamp.establish_connection!('yoururl.basecamphq.com', 'APITOKEN', 'X')
 
+=== Using OAuth access token
+
+  Basecamp.establish_oauth_connection!('yoururl.basecamphq.com', 'oauth_access_token')
+
 === With a Basecamp account that use SSL (https://yoururl.basecamphq.com)
 
   Basecamp.establish_connection!('yoururl.basecamphq.com', 'APITOKEN', 'X', true)
 
+  Basecamp.establish_oauth_connection!('yoururl.basecamphq.com', 'oauth_access_token', true)
+
 This is the same whether you're accessing using the ActiveResource interface,
 or the legacy interface.
 
@@ -59,6 +65,22 @@ information on working with ActiveResource, see:
  * http://api.rubyonrails.org/files/activeresource/README.html
  * http://api.rubyonrails.org/classes/ActiveResource/Base.html
 
+== Basecamp API rate limit and app identification
+
+If your app creates a lot of requests, you may hit the (new) basecamp rate limit. ({read more here about rate limiting}[https://github.com/basecamp/basecamp-classic-api#rate-limiting]).
+
+To raise your limit you can send a custom user-agent to basecamp with your identifying information ({read more here}[https://github.com/basecamp/basecamp-classic-api#rate-limiting]).
+
+For this you need to create an initializer in your rails application, for example: +config/inititalizer/basecamp_user_agent.rb+ with the following line:
+
+  ActiveResource::Base.headers["User-Agent"] = "Fabian's Ingenious Integration (fabian@example.com)"
+
+This initializer ensures that all requests made through ActiveResource (which this gem uses) are identifiable with your information.
+
+**NOTE**: If you are using ActiveResource for accessing multiple APIs at once and not only basecamp's, you will need the following initializer instead:
+
+  Basecamp::Resource.headers["User-Agent"] = "Fabian's Ingenious Integration (fabian@example.com)"
+
 === Finding a Resource
 
 Find a specific resource using the +find+ method. Attributes of the resource
@@ -196,6 +218,40 @@ By default the wrapper will use :xml for the active record connection but you ca
 
 Note: We recommend using xml. There are some API calls that don't behave well with json.
 
+= Access active resource response object
+
+You can acces the last response object:
+
+  Basecamp::Message.find(:all, params => { :project_id => 1037 })
+  Basecamp::Message.connection.response["status"] # => "200 OK"
+
+= Using the raw response body
+
+This is useful for example to get pagination data to access all comments in a commentable resource: https://github.com/37signals/basecamp-classic-api/blob/master/sections/comments.md#get-recent-comments-for-a-commentable-resource
+
+  def get_threshold
+    # Get the last response object
+    response = Basecamp::Comment.connection.response
+    # Parse the xml
+    xml = XmlSimple.xml_in(response.body)
+    # continued-at is an attribute specifying the path where the next oldest 75 comments can be retrieved
+    if continued_at = xml["continued-at"]
+      # There are more comments
+      # We need to extract the threshold parameter from the continued-at url
+      hash = CGI::parse(URI.parse(continued_at).query)
+      hash["threshold"].first
+    else
+      # We're done
+      nil
+    end
+  end
+
+  comments = Basecamp::Comment.find(:all, :params => { :post_id => 1037 })
+  if threshold = get_threshold
+    # Get the next set of comments using the threshold
+    Basecamp::Comment.find(:all, :params => { :post_id => 1037, :threshold => threshold })
+  end
+
 == Contributors
 
 * jamesarosen

data/lib/basecamp.rb

@@ -7,6 +7,7 @@ require 'xmlsimple'
 
 require 'basecamp/base'
 require 'basecamp/connection'
+require 'basecamp/active_resource'
 require 'basecamp/hash'
 require 'basecamp/record'
 require 'basecamp/resource'

data/lib/basecamp/active_resource.rb

@@ -0,0 +1,23 @@
+# ActiveResource connection patch to let users access the last response object and the headers.
+#
+# Example:
+#   >> Basecamp::Message.find(:all, params => { :project_id => 1037 })
+#   >> Basecamp::Message.connection.response["status"]
+#   => "200 OK"
+class ActiveResource::Connection
+  alias_method :original_handle_response, :handle_response
+  alias :static_default_header :default_header
+
+  def handle_response(response)
+    Thread.current[:active_resource_connection_headers] = response
+    original_handle_response(response)
+  end
+
+  def response
+    Thread.current[:active_resource_connection_headers]
+  end
+
+  def set_header(key, value)
+    default_header.update(key => value)
+  end
+end

data/lib/basecamp/base.rb

@@ -1,14 +1,15 @@
 module Basecamp
   class << self
     attr_accessor :use_xml
-    attr_reader :site, :user, :password, :use_ssl
+    attr_reader :site, :user, :password, :use_ssl, :use_oauth, :access_token
 
     def establish_connection!(site, user, password, use_ssl = false, use_xml = true)
-      @site     = site
-      @user     = user
-      @password = password
-      @use_ssl  = use_ssl
-      @use_xml  = use_xml
+      @site       = site
+      @user       = user
+      @password   = password
+      @use_ssl    = use_ssl
+      @use_xml    = use_xml
+      @use_oauth  = false
 
       Resource.user     = user
       Resource.password = password
@@ -18,6 +19,20 @@ module Basecamp
       @connection = Connection.new(self)
     end
 
+    def establish_oauth_connection!(site, access_token, use_ssl = false, use_xml = true)
+      @site         = site
+      @use_ssl      = use_ssl
+      @use_xml      = use_xml
+      @use_oauth    = true
+      @access_token = access_token
+
+      Resource.site         = (use_ssl ? "https" : "http") + "://" + site
+      Resource.format       = (use_xml ? :xml : :json)
+      Resource.connection.set_header('Authorization', "Bearer #{access_token}")
+
+      @connection = Connection.new(self)
+    end
+
     def connection
       @connection || raise('No connection established')
     end
@@ -25,9 +40,16 @@ module Basecamp
     # Make a raw web-service request to Basecamp. This will return a Hash of
     # Arrays of the response, and may seem a little odd to the uninitiated.
     def request(path, parameters = {})
-      response = Basecamp.connection.post(path, StringIO.new(convert_body(parameters)), "Content-Type" => content_type)
+      headers = { "Content-Type" => content_type }
+      headers.merge!('Authorization' => "Bearer #{@access_token}") if @use_oauth
+      if parameters.empty?
+        response = Basecamp.connection.get(path, headers)
+      else
+        response = Basecamp.connection.post(path, StringIO.new(convert_body(parameters)), headers)
+      end
 
       if response.code.to_i / 100 == 2
+        return {} if response.body.blank?
         result = XmlSimple.xml_in(response.body, 'keeproot' => true, 'contentkey' => '__content__', 'forcecontent' => true)
         typecast_value(result)
       else

data/lib/basecamp/connection.rb

@@ -8,7 +8,8 @@ module Basecamp; class Connection
 
   def post(path, iostream, headers = {})
     request = Net::HTTP::Post.new(path, headers.merge('Accept' => 'application/xml'))
-    request.basic_auth(@master.user, @master.password)
+    request.basic_auth(@master.user, @master.password) unless @master.use_oauth
+    request.initialize_http_header(@master.class.headers)
     request.body_stream = iostream
     request.content_length = iostream.size
     @connection.request(request)
@@ -16,7 +17,8 @@ module Basecamp; class Connection
 
   def get(path, headers = {})
     request = Net::HTTP::Get.new(path, headers.merge('Accept' => 'application/xml'))
-    request.basic_auth(@master.user, @master.password)
+    request.initialize_http_header(@master.class.headers)
+    request.basic_auth(@master.user, @master.password) unless @master.use_oauth
     @connection.request(request)
   end
 end; end

data/lib/basecamp/resources/time_entry.rb

@@ -1,5 +1,5 @@
 module Basecamp; class TimeEntry < Basecamp::Resource
-  parent_resources :project, :todo_item
+  parent_resources :project
 
   def self.all(project_id, page = 0)
     find(:all, :params => { :project_id => project_id, :page => page })

data/lib/basecamp/resources/todo_item.rb

@@ -1,6 +1,4 @@
 module Basecamp; class TodoItem < Basecamp::Resource
-  parent_resources :todo_list
-
   def todo_list(options = {})
     @todo_list ||= TodoList.find(todo_list_id, options)
   end

metadata

@@ -1,139 +1,123 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: basecamp
-version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 9
-  version: 0.0.9
+version: !ruby/object:Gem::Version
+  version: 0.0.10
 platform: ruby
-authors: 
+authors:
 - Anibal Cucco
 - James A. Rosen
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-27 00:00:00 -03:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: oauth2
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: xml-simple
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activeresource
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.3.0
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: mg
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 0
-        - 0
-        - 8
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
         version: 0.0.8
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 3
-        - 0
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
         version: 1.3.0
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: webmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 1
-        - 2
-        - 2
+      - !ruby/object:Gem::Version
         version: 1.2.2
   type: :development
-  version_requirements: *id007
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
 description: Basecamp API wrapper.
 email: nobody@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- README.rdoc
+- lib/basecamp.rb
+- lib/basecamp/active_resource.rb
 - lib/basecamp/base.rb
 - lib/basecamp/connection.rb
 - lib/basecamp/hash.rb
@@ -151,41 +135,28 @@ files:
 - lib/basecamp/resources/todo_item.rb
 - lib/basecamp/resources/todo_list.rb
 - lib/basecamp/symbol.rb
-- lib/basecamp.rb
-- README.rdoc
-has_rdoc: true
 homepage: http://github.com/anibalcucco/basecamp-wrapper
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 2.4.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Basecamp API wrapper.
 test_files: []
-
+has_rdoc: