context_io 1.0.0.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 843bcae021492b78bc1a4f0d58e90d070febd29f
+  data.tar.gz: b439a99e6362f76c617e08c26b3cd627886c5bcd
+SHA512:
+  metadata.gz: 407aaf3823f3526da813fbde2dd7e655ae40ab3ee3480f75ee8a94d556ed3ec7d244bef897b70afdae33c2d489c9f6f2794356a1ea0ac85c85df9f7939ab1994
+  data.tar.gz: 1fcfbabb2e9dbaa0dffc6253b69da21118f2fafe2934ba60bafb8a77b0a05359be16b7973e62b6a10e9d059a1ec02d385a5e7ad99e9b0fa6cc7c0c6c5c1e3f45

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in context-io.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,190 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2015 Return Path
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,147 @@
+Context.IO 2.0 API Ruby Library
+========
+*  <a href="http://context.io/docs/" target="_blank">API documentation</a>
+*  <a href="https://console.context.io/" target="_blank">API Explorer</a>
+*  <a href="http://context.io" target="_blank">Sign Up</a>
+
+## Description
+
+This library is meant to serve as a way to connect to the 2.0 version of the Context.IO API. All classes contained in the library are name spaced under the `ContextIO` module and accept keyword arguments.
+
+## Dependencies
+* <a href="https://github.com/rspec/rspec" target="_blank">rspec</a>
+* <a href="https://github.com/lostisland/faraday" target="_blank">Faraday</a>
+* <a href="https://github.com/lostisland/faraday_middleware" target="_blank">Faraday Middleware</a>
+* <a href="https://github.com/laserlemon/simple_oauth" target="_blank">Simple OAuth</a>
+
+## Install
+
+```ruby
+gem install context_io
+```
+
+## Usage
+
+First you need to instantiate a ContextIO class.
+
+```ruby
+cio = ContextIO::ContextIO.new(key: your_cio_key, secret: your_cio_secret)
+```
+
+Each class has it's own methods that are endpoints to the API. <a href="https://github.com/contextio/Ruby-ContextIO/blob/master/lib/context_io.rb#L38" target="_blank">ContextIO endpoints</a>.  From here you can fetch any accounts associated with your ContextIO Developer key.
+
+```ruby
+cio.get_accounts
+```
+
+This will return an array of all of the accounts. Each element of the array is an instantiated `Account` object with the data parsed from the API returned as instance variables.
+
+```ruby
+acc = cio.get_accounts[0].id  #=> "this_account_id"
+```
+
+An object can be created as long as it is given a valid identifier and an instantiated parent. Every class, except for ContextIO, requires a `parent` and an `identifier` To make it easier on a user of this library you do not need to know what we call each identifier.
+
+```ruby
+message = ContextIO::Message.new(parent: acc, identifier: "some id")
+```
+
+A class instantiation will not call the API. In order to retrieve the data CIO has on an object you will need to call `get` on it.
+
+```ruby
+message.subject #=> nil
+
+message = message.get
+message.subject  #=> "This message subject"
+```
+
+If an API call was not succesful, defined as not returning a status of 2XX, the library will throw a standard error with the message given in response.
+
+```ruby
+valid_length_id = "0" * 24
+ContextIO::Account.new(parent: cio, identifier: "valid_length_id").get
+#=> StandardError: HTTP code 404. Response {"type"=>"error", "value"=>"account #{valid_length_id} is invalid"}
+```
+
+Some classes have methods that can only be called if it has the proper parent. For example a `Message` could have valid parents of `Account`, `Contact`, or `Folder`. If you attempt to call a method on a class without the proper parent you will receive a standard error.
+
+```ruby
+account_message = ContextIO::Message.new(parent: account, identifier: "some id")
+account_message.get_folders
+#=> <ContextIO::Message:0x007fabc ...
+
+contact_message = ContextIO::Message.new(parent: contact, identifier: "some id")
+contact_message.get_folders
+#=> StandardError: "This method can only be called from '2.0/accounts/:account/message/:message_id'"
+```
+
+## Example of an API call return
+
+```ruby
+#=> #<ContextIO::Message:0x007fabc4dd9380
+ @addresses={"from"=>{"email"=>"from_address", "name"=>"from_name"}, "to"=>[{"email"=>"to_email"}]},
+ @api_call_made=
+  #<struct ContextIO::APICallMade::CALL_MADE_STRUCT
+   url=#<URI::HTTPS https://api.context.io/2.0/accounts/:account_id/messages>,
+   method=:get,
+   allowed_params=[],
+   rejected_params=[]>,
+ @connection=#<ContextIO::Connection:0x007fabc61e3998 @key=api_key, @secret=api_secret">,
+ @date=Uniux timestamp,
+ @date_indexed=Unix timestamp,
+ @date_received=Unix timestamp,
+ @email_message_id="<message_id>",
+ @folders=["\\Important", "INBOX", "\\Inbox", "[Gmail]/Important"],
+ @gmail_message_id="0000000000",
+ @gmail_thread_id="0000000000",
+ @message_id="00000000000000",
+ @parent=
+  #<ContextIO::Account:0x007fabc4ef2848
+   @api_call_made=#<struct ContextIO::APICallMade::CALL_MADE_STRUCT url=#<URI::HTTPS https://api.context.io/2.0/accounts>, method=:get, allowed_params=[], rejected_params=[]>,
+   @connection=#<ContextIO::Connection:0x007fabc61e3998 @key="key", @secret="secret">,
+   @created=Unix timestamp,
+   @email_addresses=["first_email_address", "second_email_address"],
+   @first_name="Name",
+   @id="0000000000000",
+   @last_name="Name",
+   @nb_messages=32,
+   @parent=#<ContextIO::ContextIO:0x007fabc61e39e8 @call_url="/2.0", @connection=#<ContextIO::Connection:0x007fabc61e3998 @key="key", @secret="secret">>,
+   @sources=
+    [{"server"=>"server",
+      "label"=>"label",
+      "username"=>"username",
+      "port"=>000,
+      "use_ssl"=>true,
+      "type"=>"imap",
+      "authentication_type"=>"authentication_type",
+      "status"=>"OK",
+      "status_message"=>nil,
+      "status_callback_url"=>nil,
+      "resource_url"=>"https://api.context.io/2.0/accounts/:account_id/sources/:label",
+      "sync_flags"=>false,
+      "callback_url"=>nil,
+      "sync_all_folders"=>false,
+      "expunge_on_deleted_flag"=>false,
+      "raw_file_list"=>false},
+   @status=200,
+   @success=true>,
+ @resource_url="https://api.context.io/2.0/accounts/:account_id/messages/:message_id",
+ @sources=[{"label"=>"source_label", "resource_url"=>"https://api.context.io/2.0/accounts/:account_id/sources/:label"}],
+ @status=200,
+ @subject="Email Subject",
+ @success=true>
+
+```
+
+#### Two notes about API returns.
+1. Each return will have an attached struct called `api_call_made`. This will contain the URL of the endpoint hit, the HTTP method, paramaters submitted with the call, and parameters rejected by the API.
+
+2. The above listing shows the parent, and grand parent, of this object. Those are private attrs on each class and are not accessible outside of that class's code.
+
+## Tests
+
+There are unit tests for this library.  If you would like to submit a pull request against this project please ensure that you include the appropriate unit tests.
+
+## Questions?
+
+If you have any questions, don't hesitate to contact support@context.io

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :console do
+  exec "pry -r context_io -I ./lib"
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "context_io"
+
+# 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

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/context_io.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'context_io/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.name          = "context_io"
+  spec.version       = ContextIO::VERSION
+  spec.authors       = ["Dane Carmichael"]
+  spec.email         = ["carmichaeldane@gmail.com"]
+
+  spec.summary       = "Provides a Ruby interface to the Context.IO API"
+  spec.description   = "Provides a Ruby interface to the Context.IO API"
+  spec.license       = "Apache 2.0"
+  spec.homepage      = "https://github.com/contextio/Ruby-ContextIO"
+
+  # 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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency "faraday", "~> 0.12"
+  spec.add_dependency "faraday_middleware", "~> 0.11"
+  spec.add_dependency "simple_oauth", "~> 0.3.1"
+end