contextio 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3726a18eda9fc6ebe4ca26a055cefc0ab8c21c6
-  data.tar.gz: 70f0f22c3c52460d4e81648f2839c05e5f88514f
+  metadata.gz: 36032da14317097955708cdfde089a2fb5a97268
+  data.tar.gz: 1e0523dcdeddf86c38e925e82091bfc2f83c0d23
 SHA512:
-  metadata.gz: 2651ef5e3d6ea6276eaaebf33761120b9e68b42be0a35e8a2cdbe5d8b04481bd1dd55b857b65ec265f601c48c07d3004b4d66e346401553b0b202c22fc57cee5
-  data.tar.gz: 6258631b9b65b5b624fbb545d8175b768997f84b10268fa05bc31617b2bba921f486934ae469bdb537874f273d27069a79a01c169379a403e1218671b894c0fa
+  metadata.gz: 4d6dae4942bbc159c1fcd1ca5237f3e59326abf46cefc283ae99133f7ab116e62f643e7aa595e9fa3c538c23cba34d6dff1e990805546c26f28bedb6fa720da1
+  data.tar.gz: 5f0efc5d25d4d4f1133ea372c8a5e9ac28183f74b8e2db2ebf2d510223247efe2fcbce691c47f750d47dc10adb6c106154c502c14879edfb0eabab518b7d7d4b

data/CHANGES.md

@@ -1,5 +1,14 @@
 # Changes
 
+## 1.7.0
+
+* Further README updates for clarity. - Johnny Goodman
+* Convert to Faraday back-end for making requests. - Ben Hamill
+* Fix bug in `ContextIO::Source` that caused the `sync_data` method to always
+  fail. - Dominik Gehl
+* Improve documentation for `ContextIO::API::ResourceCollection#where` to
+  include a link to the general API documentation. - Chris McNair
+
 ## 1.6.0
 
 * Add `version` and `base_url` instance variables to API. - Dominik Gehl

data/README.md

@@ -184,7 +184,8 @@ Pass dates in to message queries as Unix Epoch integers.
 require 'active_support/all'
 
 account.messages.where(date_before: 3.hours.ago.to_i, date_after: 5.hours.ago.to_i).each do |message|
-  puts "(#{message.date}) #{message.subject}"
+  puts message.subject      #=> "The subject of my email"
+  puts message.received_at  #=> 2013-07-31 20:33:56 -0500  
 end
 ```
 
@@ -299,12 +300,12 @@ message = account.messages[message_id]
 message.files.class                   #=> ContextIO::FileCollection
 message.files.count                   #=> 2
 message.files.map { |f| f.file_name } #=> ["at_icon.png", "argyle_slides.png"]
-message.files.first.resource_url      #=> https://contextio_to_s3_redirect_url.io
+message.files.first.content_link      #=> https://contextio_to_s3_redirect_url
 ```
 
-The file['resource_url'] url is a S3 backed temporary link. It is intended
-to be used promptly after being called. Do not store off this link. Instead,
-store off the message_id and request on demand.
+The file['content_link'] url is a S3 backed temporary link. It is intended to be
+used promptly after being called. Do not store off this link. Instead, store off
+the message_id and request on demand.
 
 
 ### On Laziness

data/Rakefile

@@ -19,6 +19,7 @@ rescue Bundler::BundlerError => e
 end
 
 require 'rake'
+require 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new

data/contextio.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_dependency 'oauth', '~> 0.4.5'
+  gem.add_dependency 'faraday', '~> 0.8.0'
+  gem.add_dependency 'faraday_middleware', '~> 0.9.0'
+  gem.add_dependency 'simple_oauth', '~> 0.2.0'
 
   gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'rubygems-tasks',  '~> 0.2'
@@ -26,5 +28,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'redcarpet'
   gem.add_development_dependency 'pry-doc'
-  gem.add_development_dependency 'fakeweb'
+  gem.add_development_dependency 'webmock'
 end

data/lib/contextio/api/resource_collection.rb

@@ -70,7 +70,8 @@ class ContextIO
       end
 
       # Specify one or more constraints for limiting resources in this
-      # collection. See individual classes for the list of valid constraints.
+      # collection. See individual classes in the
+      # [Context.IO docs](http://context.io/docs/2.0/) for the list of valid constraints.
       # Not all collections have valid where constraints at all.
       #
       # This can be chained at need and doesn't actually cause the API to get

data/lib/contextio/api.rb

@@ -1,6 +1,7 @@
 require 'uri'
-require 'oauth'
 require 'json'
+require 'faraday'
+require 'faraday_middleware'
 
 require 'contextio/api/url_builder'
 
@@ -93,15 +94,15 @@ class ContextIO
     #
     # @raise [API::Error] if the response code isn't in the 200 or 300 range.
     def request(method, resource_path, params = {})
-      response = oauth_request(method, resource_path, params)
+      response = oauth_request(method, resource_path, params, { 'Accept' => 'application/json' })
       body = response.body
-      results = JSON.parse(body) unless response.body.empty?
+      results = JSON.parse(body.to_s) unless response.body.to_s.empty?
 
-      if response.code =~ /[45]\d\d/
+      unless response.success?
         if results.is_a?(Hash) && results['type'] == 'error'
           message = results['value']
         else
-          message = response.message
+          message = "HTTP #{response.status} Error"
         end
 
         raise API::Error, message
@@ -111,10 +112,10 @@ class ContextIO
     end
 
     def raw_request(method, resource_path, params={})
-      response = oauth_request(method, resource_path, params, 'User-Agent' => user_agent_string)
+      response = oauth_request(method, resource_path, params)
 
-      if response.code =~ /[45]\d\d/
-        raise API::Error, response.message
+      unless response.success?
+        raise API::Error, "HTTP #{response.status} Error"
       end
 
       response.body
@@ -129,24 +130,18 @@ class ContextIO
     # @param [{String, Symbol => String, Symbol, Array<String, Symbol>}] params
     #   A Hash of the query parameters for the action represented by this
     #   request.
+    # @param [{String, Symbol => String, Symbol, Array<String, Symbol>}] headers
+    #   A Hash of headers to be merged with the default headers for making
+    #   requests.
     #
-    # @return [Net::HTTP*] The response object from the request.
+    # @return [Faraday::Response] The response object from the request.
     def oauth_request(method, resource_path, params, headers=nil)
-      headers ||= { 'Accept' => 'application/json', 'User-Agent' => user_agent_string }
       normalized_params = params.inject({}) do |normalized_params, (key, value)|
         normalized_params[key.to_sym] = value
         normalized_params
       end
 
-      # 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), normalized_params, headers)
-      else # GET, DELETE, HEAD, etc.
-        token.request(method, path(resource_path, normalized_params), nil, headers)
-      end
+      connection.send(method, path(resource_path), normalized_params, headers)
     end
 
     # So that we can accept full URLs, this strips the domain and version number
@@ -179,18 +174,17 @@ class ContextIO
       "?#{URI.encode_www_form(params)}"
     end
 
-    # @!attribute [r] consumer
-    # @return [OAuth::Consumer] An Oauth consumer object for credentials
-    #   purposes.
-    def consumer
-      @consumer ||= OAuth::Consumer.new(key, secret, @opts.merge(site: base_url))
-    end
+    # @!attribute [r] connection
+    # @return [Faraday::Connection] A handle on the Faraday connection object.
+    def connection
+      @connection ||= Faraday::Connection.new(base_url) do |faraday|
+        faraday.headers['User-Agent'] = user_agent_string
+
+        faraday.request :oauth, consumer_key: key, consumer_secret: secret
+        faraday.request :url_encoded
 
-    # @!attribute [r] token
-    # @return [Oauth::AccessToken] An Oauth token object for credentials
-    #   purposes.
-    def token
-      @token ||= OAuth::AccessToken.new(consumer)
+        faraday.adapter Faraday.default_adapter
+      end
     end
   end
 end

data/lib/contextio/source.rb

@@ -49,7 +49,7 @@ class ContextIO
 
       sync_hashes = api.request(:get, "#{resource_url}/sync")
 
-      @sync_data = ContextIO::SourceSyncData.new(sync_hashes)
+      @sync_data = ContextIO::SourceSyncData.new(label, sync_hashes)
 
       return @sync_data
     end

data/lib/contextio/version.rb

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

data/spec/integration/source_sync_data_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'contextio'
+
+describe "Syncing data for a source" do
+  let(:api) { double(:api) }
+  subject { ContextIO::Source.new(api, resource_url: 'resource url') }
+
+  before do
+    allow(api).to receive(:request).and_return({foo: 'bar'})
+  end
+
+  it "initializes a SourceSyncData correctly" do
+    expect { subject.sync_data }.to_not raise_exception
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'rspec'
 require 'pry'
-require 'fakeweb'
+require 'webmock/rspec'
 
 RSpec.configure do |rspec|
   rspec.run_all_when_everything_filtered = true
@@ -18,4 +18,4 @@ RSpec.configure do |rspec|
   end
 end
 
-FakeWeb.allow_net_connect = false
+WebMock.disable_net_connect!

data/spec/unit/contextio/api_spec.rb

@@ -122,9 +122,11 @@ describe ContextIO::API do
 
     context "with a good response" do
       before do
-        FakeWeb.register_uri(
+        WebMock.stub_request(
           :get,
-          'https://api.context.io/2.0/test',
+          'https://api.context.io/2.0/test'
+        ).to_return(
+          status: 200,
           body: JSON.dump('a' => 'b', 'c' => 'd')
         )
       end
@@ -136,10 +138,11 @@ describe ContextIO::API do
 
     context "with a bad response that has a body" do
       before do
-        FakeWeb.register_uri(
+        WebMock.stub_request(
           :get,
-          'https://api.context.io/2.0/test',
-          status: ['400', 'Bad Request'],
+          'https://api.context.io/2.0/test'
+        ).to_return(
+          status: 400,
           body: JSON.dump('type' => 'error', 'value' => 'nope')
         )
       end
@@ -151,15 +154,16 @@ describe ContextIO::API do
 
     context "with a bad response that has no body" do
       before do
-        FakeWeb.register_uri(
+        WebMock.stub_request(
           :get,
-          'https://api.context.io/2.0/test',
-          status: ['400', 'Bad Request']
+          'https://api.context.io/2.0/test'
+        ).to_return(
+          status: 400
         )
       end
 
       it "raises an API error with the header message" do
-        expect { subject }.to raise_error(ContextIO::API::Error, 'Bad Request')
+        expect { subject }.to raise_error(ContextIO::API::Error, 'HTTP 400 Error')
       end
     end
   end

metadata

@@ -1,139 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: contextio
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Ben Hamill
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
+date: 2014-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: oauth
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.5
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-doc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fakeweb
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Provides Ruby interface to Context.IO
@@ -143,10 +171,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .rspec
-- .yardopts
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
 - CHANGES.md
 - Gemfile
 - LICENSE.md
@@ -191,6 +219,7 @@ files:
 - spec/config.yml.example
 - spec/integration/accounts_messages_spec.rb
 - spec/integration/folders_messages_spec.rb
+- spec/integration/source_sync_data_spec.rb
 - spec/spec_helper.rb
 - spec/unit/contextio/account_collection_spec.rb
 - spec/unit/contextio/account_spec.rb
@@ -218,17 +247,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Provides interface to Context.IO
@@ -236,6 +265,7 @@ test_files:
 - spec/config.yml.example
 - spec/integration/accounts_messages_spec.rb
 - spec/integration/folders_messages_spec.rb
+- spec/integration/source_sync_data_spec.rb
 - spec/spec_helper.rb
 - spec/unit/contextio/account_collection_spec.rb
 - spec/unit/contextio/account_spec.rb