nylas 0.15.7 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c3f019770b98e6a72a044cdcf7ccbb96d70097d
-  data.tar.gz: e3852339688f23e4cf923ebaf6d77c27b82da6e2
+  metadata.gz: c3cac942ceef6b5861af5e0061654bb9add860e8
+  data.tar.gz: 64a71d0ddadb1bbe1e1e34f5395b68880191641e
 SHA512:
-  metadata.gz: 3dbd4c036713cc873459285d37d7148a2e42174c63f7b65f392fe1d27e769086a680e6d80743c3f4e9c5531f308cd0044640e099087c0adf87a3eec06dfd6f58
-  data.tar.gz: 3e35932764459d492cff8aeac30dc94cb051e7e78f1af906c6b6f13d23f9181c3294194f9c69987fb09c07b449a55421a98792a3364bb264a5c06de04275c82e
+  metadata.gz: 25b349a679805acb2f70a4c993078cb8f23a51e72850843287e8dcaa00e3adfa7fe5a85bae6ffb1580ce144e0ae54c2d892af90d233a15d192c1e08390a92e41
+  data.tar.gz: 6826d6d73284d7e14efdcfa3416243ef393c5e8599578de9fef272e5588d8065bb870d75c84f90e6735680eb1433d35295570f54246dae46cb1a0867dcf4fa00

data/README.md

@@ -4,7 +4,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'inbox'
+    gem 'nylas'
 
 And then execute:
 
@@ -12,7 +12,7 @@ And then execute:
 
 You don't need to use this repo unless you're planning to modify the gem. If you just want to use the Inbox SDK with Ruby bindings, you should run:
 
-    gem install inbox
+    gem install nylas
 
 
 ##Requirements
@@ -30,13 +30,13 @@ A small example Rails app is included in the `example` directory. You can run th
 
 `RESTCLIENT_LOG=stdout rails s`
 
-*Note that you will need to replace the Inbox App ID and Secret in `config/environments/development.rb` to use the sample app.*
+*Note that you will need to replace the Nylas App ID and Secret in `config/environments/development.rb` to use the sample app.*
 
 ## Usage
 
 ### App ID and Secret
 
-Before you can interact with the Inbox API, you need to register for the Nylas Developer Program at [https://www.nylas.com/](https://www.nylas.com/). After you've created a developer account, you can create a new application to generate an App ID / Secret pair.
+Before you can interact with the Nylas API, you need to register for the Nylas Developer Program at [https://www.nylas.com/](https://www.nylas.com/). After you've created a developer account, you can create a new application to generate an App ID / Secret pair.
 
 Generally, you should store your App ID and Secret into environment variables to avoid adding them to source control. That said, in the example project and code snippets below, the values were added to `config/environments/development.rb` for convenience.
 
@@ -48,17 +48,17 @@ The Nylas REST API uses server-side (three-legged) OAuth, and the Ruby gem provi
 **Step 1: Redirect the user to Nylas:**
 
 ```ruby
-require 'inbox'
+require 'nylas'
 
 def login
-  inbox = Nylas::API.new(config.inbox_app_id, config.inbox_app_secret, nil)
+  nylas = Nylas::API.new(config.nylas_app_id, config.nylas_app_secret, nil)
   # The email address of the user you want to authenticate
   user_email = 'ben@nylas.com'
 
   # This URL must be registered with your application in the developer portal
   callback_url = url_for(:action => 'login_callback')
 
-  redirect_to inbox.url_for_authentication(callback_url, user_email)
+  redirect_to nylas.url_for_authentication(callback_url, user_email)
 end
 ```
 
@@ -66,60 +66,43 @@ end
 
 ```ruby
 def login_callback
-  inbox = Nylas::API.new(config.inbox_app_id, config.inbox_app_secret, nil)
-  inbox_token = inbox.token_for_code(params[:code])
+  nylas = Nylas::API.new(config.nylas_app_id, config.nylas_app_secret, nil)
+  nylas_token = nylas.token_for_code(params[:code])
 
-  # Save the inbox_token to the current session, save it to the user model, etc.
+  # Save the nylas_token to the current session, save it to the user model, etc.
 end
 ```
 
 ### Managing Billing
 
-If you're using the open-source version of the Nylas Sync Engine or have fewer than 10 accounts associated with your developer app, you don't need to worry about billing. However, if you've requested production access to the Sync Engine, you are billed monthly based on the number of email accounts you've connected to Inbox. You can choose to start accounts in "trial" state and sync slowly at a rate of one message per minute so users can try out your app. If you use trial mode, you need to upgrade accounts (and start paying for them) within 30 days or they will automatically expire. You may wish to upgrade accounts earlier to dramatically speed up the mail sync progress depending on your app's needs.
-
-**Starting an Account in Trial Mode**
-
-When you're redirecting the user to Nylas to authenticate with their email provider,
-pass the additional `trial: true` option to start their account in trial mode.
-
-```ruby
-  redirect_to inbox.url_for_authentication(callback_url, user_email, {trial: true})
-```
-
-**Upgrading an Account**
-
-```ruby
-  inbox = Nylas::API.new(config.inbox_app_id, config.inbox_app_secret, nil)
-  account = inbox.accounts.find(account_id)
-  account.upgrade!
-```
+If you're using the open-source version of the Nylas Sync Engine or have fewer than 10 accounts associated with your developer app, you don't need to worry about billing. However, if you've requested production access to the Sync Engine, you are billed monthly based on the number of email accounts you've connected to Nylas.
 
 **Cancelling an Account**
 
 ```ruby
-  inbox = Nylas::API.new(config.inbox_app_id, config.inbox_app_secret, nil)
-  account = inbox.accounts.find(account_id)
+  nylas = Nylas::API.new(config.nylas_app_id, config.nylas_app_secret, nil)
+  account = nylas.accounts.find(account_id)
   account.downgrade!
 
-  # Your Inbox API token will be revoked, you will not be charged
+  # Your Nylas API token will be revoked, you will not be charged
 ```
 
 ### Account Status
 
 ````ruby
   # Query the status of every account linked to the app
-  inbox = Nylas::API.new(config.inbox_app_id, config.inbox_app_secret, inbox_token)
-  accounts = inbox.accounts
+  nylas = Nylas::API.new(config.nylas_app_id, config.nylas_app_secret, nylas_token)
+  accounts = nylas.accounts
   accounts.each { |a| [a.account_id, a.sync_state] } # Available fields are: account_id, sync_state, trial, trial_expires, billing_state and namespace_id. See lib/account.rb for more details.
 ```
 
 ### Fetching Namespaces
 
 ```ruby
-inbox = Nylas::API.new(config.inbox_app_id, config.inbox_app_secret, inbox_token)
+nylas = Nylas::API.new(config.nylas_app_id, config.nylas_app_secret, nylas_token)
 
 # Get the first namespace
-namespace = inbox.namespaces.first
+namespace = nylas.namespaces.first
 
 # Print out the email address and provider (Gmail, Exchange)
 puts namespace.email_address
@@ -211,7 +194,7 @@ Each of the primary collections (contacts, messages, etc.) behave the same way a
 messages = namespace.messages.where(:to => 'ben@nylas.com`).all
 ```
 
-The `where` method accepts a hash of filters, as documented in the [Inbox Filters Documentation](https://www.nylas.com/docs/api#filters).
+The `where` method accepts a hash of filters, as documented in the [Filters Documentation](https://www.nylas.com/docs/api#filters).
 
 ### Getting the raw contents of a message
 
@@ -271,10 +254,10 @@ The delta sync API allows fetching all the changes that occured since a specifie
 #
 # we first need to get a cursor object a cursor is simply the id of
 # an individual change.
-cursor = inbox.namespaces.first.get_cursor(1407543195)
+cursor = nylas.namespaces.first.get_cursor(1407543195)
 
 last_cursor = nil
-inbox.namespaces.first.deltas(cursor) do |event, object|
+nylas.namespaces.first.deltas(cursor) do |event, object|
     if event == "create" or event == "modify"
         if object.is_a?(Nylas::Contact)
             puts "#{object.name} - #{object.email}"
@@ -297,7 +280,7 @@ save_to_db(last_cursor)
 
 ### Exclude changes from a specific type --- get only messages
 ````ruby
-inbox.namespaces.first.deltas(cursor, exclude=[Nylas::Contact,
+nylas.namespaces.first.deltas(cursor, exclude=[Nylas::Contact,
                                                Nylas::Event,
                                                Nylas::File,
                                                Nylas::Tag,
@@ -331,7 +314,7 @@ Code | Error Type | Description
 
 ## Open-Source Sync Engine
 
-The [Nylas Sync Engine](http://github.com/inboxapp/inbox) is open-source, and you can also use the Ruby gem with the open-source API. Since the open-source API provides no authentication or security, connecting to it is simple. When you instantiate the Inbox object, provide `nil` for the App ID, App Secret, and API Token, and pass the fully-qualified address to your copy of the sync engine:
+The [Nylas Sync Engine](http://github.com/nylas/sync-engine) is open source, and you can also use the Ruby gem with the open source API. Since the open source API provides no authentication or security, connecting to it is simple. When you instantiate the Nylas object, provide `nil` for the App ID, App Secret, and API Token, and pass the fully-qualified address to your copy of the sync engine:
 
 ```ruby
 require 'inbox'
@@ -341,7 +324,7 @@ inbox = Nylas::API.new(nil, nil, nil, 'http://localhost:5555/')
 
 ## Contributing
 
-We'd love your help making the Nylas ruby gem better. Join the Google Group for project updates and feature discussion. We also hang out in `#Nylas` on [irc.freenode.net](http://irc.freenode.net), or you can email [support@nylas.com](mailto:support@nylas.com).
+We'd love your help making the Nylas ruby gem better. Join the Google Group for project updates and feature discussion. We also have a [Slack community](nylas-slack-invite.heroku.com) where we provide support, or you can email [support@nylas.com](mailto:support@nylas.com).
 
 Please sign the [Contributor License Agreement](https://www.nylas.com/cla.html) before submitting pull requests. (It's similar to other projects, like NodeJS or Meteor.)
 
@@ -354,13 +337,15 @@ Tests can be run with:
 
 The Nylas ruby gem uses [Jeweler](https://github.com/technicalpickles/jeweler) for release management. Jeweler should be installed automatically when you call `bundle`, and extends `rake` to include a few more commands. When you're ready to release a new version, edit `lib/version.rb` and then build:
 
-    rake build
+    rake inbox_build
+    rake nylas_build
 
 Test your new version (found in `pkg/`) locally, and then release with:
 
-    rake release
+    rake inbox_release
+    rake nylas_release
 
-If it's your first time updating the ruby gem, you may be prompted for the username/password for rubygems.org. Members of the Nylas team can find that by doing `fetch-password rubygems`.
+If it's your first time updating the ruby gems, you may be prompted for the username/password for rubygems.org. Members of the Nylas team can find that by doing `fetch-password rubygems`.
 
 ## OAuth self-test
 

data/lib/calendar.rb

@@ -6,6 +6,7 @@ module Inbox
 
     parameter :name
     parameter :description
+    parameter :read_only
 
     def events
       @events ||= RestfulModelCollection.new(Event, @_api, @namespace, {:calendar_id=>@id})

data/lib/nylas.rb

@@ -0,0 +1,141 @@
+require 'version'
+require 'rest-client'
+require 'restful_model_collection'
+require 'json'
+require 'namespace'
+require 'account'
+
+module Inbox
+
+  class AccessDenied < StandardError; end
+  class ResourceNotFound < StandardError; end
+  class NoAuthToken < StandardError; end
+  class UnexpectedAccountAction < StandardError; end
+  class UnexpectedResponse < StandardError; end
+  class APIError < StandardError
+    attr_accessor :error_type
+    def initialize(type, error)
+      super(error)
+      self.error_type = type
+    end
+  end
+  class InvalidRequest < APIError; end
+  class MessageRejected < APIError; end
+  class SendingQuotaExceeded < APIError; end
+  class ServiceUnavailable < APIError; end
+
+  def self.interpret_http_status(result)
+    # Handle HTTP errors and RestClient errors
+    raise ResourceNotFound.new if result.code.to_i == 404
+    raise AccessDenied.new if result.code.to_i == 403
+  end
+
+  def self.interpret_response(result, result_content, options = {})
+    # Handle HTTP errors
+    Inbox.interpret_http_status(result)
+
+    # Handle content expectation errors
+    raise UnexpectedResponse.new if options[:expected_class] && result_content.empty?
+    json = JSON.parse(result_content)
+    if json.is_a?(Hash) && (json['type'] == 'api_error' or json['type'] == 'invalid_request_error')
+      if result.code.to_i == 400
+        exc = InvalidRequest
+      elsif result.code.to_i == 402
+        exc = MessageRejected
+      elsif result.code.to_i == 429
+        exc = SendingQuotaExceeded
+      elsif result.code.to_i == 503
+        exc = ServiceUnavailable
+      else
+        exc = APIError
+      end
+      raise exc.new(json['type'], json['message'])
+    end
+    raise UnexpectedResponse.new(result.msg) if result.is_a?(Net::HTTPClientError)
+    raise UnexpectedResponse.new if options[:expected_class] && !json.is_a?(options[:expected_class])
+    json
+
+  rescue JSON::ParserError => e
+    # Handle parsing errors
+    raise UnexpectedResponse.new(e.message)
+  end
+
+
+  class API
+    attr_accessor :api_server
+    attr_reader :access_token
+    attr_reader :app_id
+    attr_reader :app_secret
+
+    def initialize(app_id, app_secret, access_token = nil, api_server = 'https://api.nylas.com',
+                   service_domain = 'api.nylas.com')
+      raise "When overriding the Inbox API server address, you must include https://" unless api_server.include?('://')
+      @api_server = api_server
+      @access_token = access_token
+      @app_secret = app_secret
+      @app_id = app_id
+      @service_domain = service_domain
+      @version = Inbox::VERSION
+
+      if ::RestClient.before_execution_procs.empty?
+        ::RestClient.add_before_execution_proc do |req, params|
+          req.add_field('X-Inbox-API-Wrapper', 'ruby')
+          req['User-Agent'] = "Ruby SDK #{@version} - #{RUBY_VERSION}"
+        end
+      end
+    end
+
+    def url_for_path(path)
+      raise NoAuthToken.new if @access_token == nil and (@app_secret != nil or @app_id != nil)
+      protocol, domain = @api_server.split('//')
+      "#{protocol}//#{@access_token}:@#{domain}#{path}"
+    end
+
+    def url_for_authentication(redirect_uri, login_hint = '', options = {})
+      trialString = 'false'
+      if options[:trial] == true
+        trialString = 'true'
+      end
+      "https://#{@service_domain}/oauth/authorize?client_id=#{@app_id}&trial=#{trialString}&response_type=code&scope=email&login_hint=#{login_hint}&redirect_uri=#{redirect_uri}"
+    end
+
+    def url_for_management
+      protocol, domain = @api_server.split('//')
+      accounts_path = "#{protocol}//#{@app_secret}:@#{domain}/a/#{@app_id}/accounts"
+    end
+
+    def set_access_token(token)
+      @access_token = token
+    end
+
+    def token_for_code(code)
+      data = {
+          'client_id' => app_id,
+          'client_secret' => app_secret,
+          'grant_type' => 'authorization_code',
+          'code' => code
+      }
+
+      ::RestClient.post("https://#{@service_domain}/oauth/token", data) do |response, request, result|
+        json = Inbox.interpret_response(result, response, :expected_class => Object)
+        return json['access_token']
+      end
+    end
+
+    # Convenience Methods
+
+    def namespaces
+      @namespaces ||= RestfulModelCollection.new(Namespace, self, nil)
+      @namespaces
+    end
+
+    # Billing Methods
+
+    def accounts
+      @accounts ||= ManagementModelCollection.new(Account, self, nil)
+      @accounts
+    end
+  end
+end
+
+Nylas = Inbox.clone

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Inbox
-  VERSION = "0.15.7"
+  VERSION = "0.16.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nylas
 version: !ruby/object:Gem::Version
-  version: 0.15.7
+  version: 0.16.0
 platform: ruby
 authors:
 - Ben Gotow
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-05 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -174,6 +174,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- LICENSE.txt
+- README.md
 - lib/account.rb
 - lib/api_thread.rb
 - lib/calendar.rb
@@ -184,6 +186,7 @@ files:
 - lib/inbox.rb
 - lib/message.rb
 - lib/namespace.rb
+- lib/nylas.rb
 - lib/parameters.rb
 - lib/restful_model.rb
 - lib/restful_model_collection.rb
@@ -191,9 +194,7 @@ files:
 - lib/tag.rb
 - lib/time_attr_accessor.rb
 - lib/version.rb
-- LICENSE.txt
-- README.md
-homepage: http://github.com/nylas/inbox-ruby
+homepage: http://github.com/nylas/nylas-ruby
 licenses:
 - MIT
 metadata: {}
@@ -213,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gem for interacting with the Nylas API