contextio 1.2.3 → 1.2.4

data/CHANGES.md

@@ -1,5 +1,14 @@
 # Changes
 
+## 1.2.4
+
+* Add link to gem documentation to top of README. - Ben Hamill
+* Expand README to clarify gem usage. - Ben Hamill
+* Make `ResourceCollection#[]` correctly pass down the "owning" associated
+  object to instances created with it. - Ben Hamill
+* Work around the OAuth gem handling PUT request signing a bit oddly. - Ben
+  Hamill
+
 ## 1.2.3
 
 * Fix infinite loop in ConnectToken URL building. - Ben Hamill

data/README.md

@@ -2,24 +2,50 @@
 
 * [Homepage](https://github.com/contextio/contextio-ruby#readme)
 * [API Documentation](http://context.io/docs/2.0/)
+* [Gem Documentation](http://rubydoc.info/gems/contextio/frames)
 * [Sign Up](http://context.io)
 
+
 ## Description
 
 Provides a Ruby interface to [Context.IO](http://context.io). The general design
 was inspired by the wonderful [aws-sdk](https://github.com/aws/aws-sdk-ruby)
 gem. You start with an object that represents your account with Context.IO and
-then you deal with collections within that going forward. Check out the example.
+then you deal with collections within that going forward (see the [Usage
+section](#usage)).
+
+
+## A Note On Method Names
+
+If you're looking at the [Context.IO docs](http://context.io/docs/2.0/), it is
+important to note that there are some attributes that've been renamed to be a
+bit more Ruby-friendly. In general, if the API returns a number meant to be
+seconds-from-epoch, then it's been converted to return a `Time` (e.g. `updated`
+has changed to `updated_at`) and a boolean has converted to something with a `?`
+at the end (e.g. `HasChildren` and `initial_import_finished` are `has_children?`
+and `initial_import_finished?`, respectively). See the [gem
+docs](http://rubydoc.info/gems/contextio/frames) for a specific class when in
+doubt.
+
+
+## Install
+
+    $ gem install contextio
+
+Or, of course, put this in your Gemfile:
+
+    gem contextio
 
-If you're looking at the Context.IO docs, it is important to note that there are
-some attributes that've been renamed to be a bit more Ruby-friendly. In general,
-if the API returns a number meant to be seconds-from-epoch, then it's been
-converted to return a `Time` (e.g. `updated` has changed to `updated_at`) and a
-boolean has converted to something with a `?` at the end (e.g. `HasChildren` and
-`initial_import_finished` are `has_children?` and `initial_import_finished?`,
-respectively).
 
-## Examples
+## Version Numbers
+
+This gem adheres to [SemVer](http://semver.org/). So you should be pretty safe
+upgrading from 1.0.0 to 1.9.9. Whatever as long as the major version doesn't
+bump. When the major version bumps, be warned; upgrading will take some kind of
+effort.
+
+
+## Usage
 
 ```ruby
 require 'contextio'
@@ -47,23 +73,53 @@ require 'contextio'
 contextio = ContextIO.new('your_api_key', 'your_api_secret')
 
 account = contextio.accounts[some_account_id]
-email_Address = account.messages[some_message_id]
+message = account.messages[some_message_id]
 ```
 
-## Install
 
-    $ gem install contextio
+### On Laziness
 
-Or, of course, put this in your Gemfile:
+This gem is architected to be as lazy as possible. It won't make an HTTP request
+until you ask it for some data that it knows it needs to fetch. An example might
+be illustrative:
 
-    gem contextio
+```ruby
+require 'contextio'
 
-## Version Numbers
+contextio = ContextIO.new('your_api_key', 'your_api_secret')
+
+account = contextio.accounts['1234'] # No request made here.
+account.last_name # Request made here.
+account.first_name # No request made here.
+```
+
+Note that when it made the request, it stored the data it got back, which
+included the first name, so it didn't need to make a second request. Asking for
+the value of any attribute listed in the [gem
+docs](http://rubydoc.info/gems/contextio/frames) will trigger the request.
+
+
+### On Requests and Methods
+
+There are some consistent mappings between the requests documented in the [API
+docs](http://context.io/docs/2.0/) and the methods implemented in the gem.
+
+**For collections of resources:**
+
+* the object its self sort of represents the collection-level `GET` (treat it
+  like any other `Enumerable`).
+* `#where` is how you set up the filters on the collection-level `GET`.
+* `#create` maps to the collection-level `POST` or `PUT`, as appropriate.
+* `#[]` maps to the individual-level `GET`, but (as mentioned above) is lazy.
+
+**For individual resources**
+
+* the object its self sort of represents the individual-level `GET` (but see
+  `#[]` above).
+* `#delete` maps to the individual-level `DELETE`.
+* `#update` maps to the individual-level `POST` (except in a few cases like
+  `Message#copy_to` and `Message#move_to`).
 
-This gem adheres to [SemVer](http://semver.org/). So you should be pretty safe
-upgrading from 1.0.0 to 1.9.9. Whatever as long as the major version doesn't
-bump. When the major version bumps, be warned; upgrading will take some kind of
-effort.
 
 ## Contributing
 
@@ -81,8 +137,9 @@ likely to get in (or get in faster) the closer you stick to these steps:
 If you don't know how to fix something, even just a Pull Request that includes a
 failing test can be helpful. If in doubt, make an Issue to discuss.
 
+
 ## Copyright
 
 Copyright (c) 2012 Context.IO
 
-See LICENSE.md for details.
+This gem is distributed under the MIT License. See LICENSE.md for details.

data/lib/contextio/api/resource.rb

@@ -190,7 +190,7 @@ class ContextIO
         #   resource.
         def belongs_to(association_name)
           define_method(association_name) do
-            if instance_variable_get("@#{association_name}")
+            if instance_variable_defined?("@#{association_name}")
               instance_variable_get("@#{association_name}")
             else
               association_attrs = api_attributes[association_name.to_s]
@@ -219,7 +219,15 @@ class ContextIO
           define_method(association_name) do
             association_class = ContextIO::API::AssociationHelpers.class_for_association_name(association_name)
 
-            instance_variable_get("@#{association_name}") || instance_variable_set("@#{association_name}", association_class.new(api, self.class.association_name => self, attribute_hashes: api_attributes[association_name.to_s]))
+            instance_variable_get("@#{association_name}") ||
+              instance_variable_set(
+                "@#{association_name}",
+                association_class.new(
+                  api,
+                  self.class.association_name => self,
+                  attribute_hashes: api_attributes[association_name.to_s]
+                )
+              )
           end
 
           associations << association_name.to_sym

data/lib/contextio/api/resource_collection.rb

@@ -103,7 +103,7 @@ class ContextIO
       # @param [String] key The Provider Consumer Key for the
       #   provider you want to interact with.
       def [](key)
-        resource_class.new(api, resource_class.primary_key => key)
+        resource_class.new(api, associations_hash.merge(resource_class.primary_key => key))
       end
 
       private

data/lib/contextio/api.rb

@@ -130,10 +130,14 @@ class ContextIO
     def oauth_request(method, resource_path, params, headers=nil)
       headers ||= { 'Accept' => 'application/json', 'User-Agent' => user_agent_string }
 
-      if %w(put post).include? method.to_s.downcase
+      # The below array used to include put, too, but there is a weirdness in
+      # the oauth gem with PUT and signing requests. See
+      # https://github.com/oauth/oauth-ruby/pull/34#issuecomment-5862199 for
+      # some discussion on the matter. This is a work-around.
+      if %w(post).include? method.to_s.downcase
         token.request(method, path(resource_path), params, headers)
       else # GET, DELETE, HEAD, etc.
-        token.request(method, path(resource_path, params), headers)
+        token.request(method, path(resource_path, params), nil, headers)
       end
     end
 

data/lib/contextio/version.rb

@@ -1,6 +1,6 @@
 class ContextIO
   # @private
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 
   # The gem version.
   #

data/spec/integration/accounts_messages_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'contextio'
+
+describe "A Message created from an Account" do
+  let(:api) { double(:api) }
+  let(:account) { ContextIO::Account.new(api, id: '1234', messages: [{}]) }
+  let(:message) { account.messages['4321'] }
+
+  it "has a handle back to the account" do
+    expect(message.account).to be(account)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contextio
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
@@ -208,23 +208,24 @@ files:
 - lib/contextio/webhook.rb
 - lib/contextio/webhook_collection.rb
 - spec/config.yml.example
-- spec/contextio/account_collection_spec.rb
-- spec/contextio/account_spec.rb
-- spec/contextio/api/association_helpers_spec.rb
-- spec/contextio/api/resource_collection_spec.rb
-- spec/contextio/api/resource_spec.rb
-- spec/contextio/api/url_builder_spec.rb
-- spec/contextio/api_spec.rb
-- spec/contextio/connect_token_collection_spec.rb
-- spec/contextio/connect_token_spec.rb
-- spec/contextio/email_settings_spec.rb
-- spec/contextio/oauth_provider_collection_spec.rb
-- spec/contextio/oauth_provider_spec.rb
-- spec/contextio/source_collection_spec.rb
-- spec/contextio/source_spec.rb
-- spec/contextio/version_spec.rb
-- spec/contextio_spec.rb
+- spec/integration/accounts_messages_spec.rb
 - spec/spec_helper.rb
+- spec/unit/contextio/account_collection_spec.rb
+- spec/unit/contextio/account_spec.rb
+- spec/unit/contextio/api/association_helpers_spec.rb
+- spec/unit/contextio/api/resource_collection_spec.rb
+- spec/unit/contextio/api/resource_spec.rb
+- spec/unit/contextio/api/url_builder_spec.rb
+- spec/unit/contextio/api_spec.rb
+- spec/unit/contextio/connect_token_collection_spec.rb
+- spec/unit/contextio/connect_token_spec.rb
+- spec/unit/contextio/email_settings_spec.rb
+- spec/unit/contextio/oauth_provider_collection_spec.rb
+- spec/unit/contextio/oauth_provider_spec.rb
+- spec/unit/contextio/source_collection_spec.rb
+- spec/unit/contextio/source_spec.rb
+- spec/unit/contextio/version_spec.rb
+- spec/unit/contextio_spec.rb
 homepage: https://github.com/contextio/contextio-ruby#readme
 licenses:
 - MIT
@@ -252,21 +253,22 @@ specification_version: 3
 summary: Provides interface to Context.IO
 test_files:
 - spec/config.yml.example
-- spec/contextio/account_collection_spec.rb
-- spec/contextio/account_spec.rb
-- spec/contextio/api/association_helpers_spec.rb
-- spec/contextio/api/resource_collection_spec.rb
-- spec/contextio/api/resource_spec.rb
-- spec/contextio/api/url_builder_spec.rb
-- spec/contextio/api_spec.rb
-- spec/contextio/connect_token_collection_spec.rb
-- spec/contextio/connect_token_spec.rb
-- spec/contextio/email_settings_spec.rb
-- spec/contextio/oauth_provider_collection_spec.rb
-- spec/contextio/oauth_provider_spec.rb
-- spec/contextio/source_collection_spec.rb
-- spec/contextio/source_spec.rb
-- spec/contextio/version_spec.rb
-- spec/contextio_spec.rb
+- spec/integration/accounts_messages_spec.rb
 - spec/spec_helper.rb
+- spec/unit/contextio/account_collection_spec.rb
+- spec/unit/contextio/account_spec.rb
+- spec/unit/contextio/api/association_helpers_spec.rb
+- spec/unit/contextio/api/resource_collection_spec.rb
+- spec/unit/contextio/api/resource_spec.rb
+- spec/unit/contextio/api/url_builder_spec.rb
+- spec/unit/contextio/api_spec.rb
+- spec/unit/contextio/connect_token_collection_spec.rb
+- spec/unit/contextio/connect_token_spec.rb
+- spec/unit/contextio/email_settings_spec.rb
+- spec/unit/contextio/oauth_provider_collection_spec.rb
+- spec/unit/contextio/oauth_provider_spec.rb
+- spec/unit/contextio/source_collection_spec.rb
+- spec/unit/contextio/source_spec.rb
+- spec/unit/contextio/version_spec.rb
+- spec/unit/contextio_spec.rb
 has_rdoc: