context-io 0.0.1

data/lib/context-io/resource.rb

@@ -0,0 +1,16 @@
+require 'context-io/connection'
+require 'context-io/request'
+
+module ContextIO
+  # The superclass of all resources provided by the API
+  #
+  # @api private
+  class Resource
+    include ContextIO::Connection
+    include ContextIO::Request
+
+    extend ContextIO::Connection
+    extend ContextIO::Request
+  end
+end
+

data/lib/context-io/response.rb

@@ -0,0 +1,5 @@
+module ContextIO
+  # Namespace for response 
+  module Response
+  end
+end

data/lib/context-io/response/parse_json.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'multi_json'
+
+module ContextIO
+  module Response
+    # Faraday middleware for parsing JSON in the response body
+    #
+    # @api private
+    class ParseJson < Faraday::Response::Middleware
+      # Parse the response body into JSON
+      #
+      # @param [#to_s] The response body, containing JSON data.
+      #
+      # @return [Object] The parsed JSON data, probably an Array or a Hash.
+      def parse(body)
+        case body
+        when ''
+          nil
+        when 'true'
+          true
+        when 'false'
+          false
+        else
+          ::MultiJson.decode(body)
+        end
+      end
+    end
+  end
+end
+

data/lib/context-io/response/raise_client_error.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+require 'context-io/error/bad_request'
+require 'context-io/error/forbidden'
+require 'context-io/error/not_found'
+require 'context-io/error/unauthorized'
+require 'context-io/error/payment_required'
+
+module ContextIO
+  module Response
+    # Faraday middleware for raising errors on 4xx HTTP status codes
+    #
+    # @api private
+    class RaiseClientError < Faraday::Response::Middleware
+      # Raise an error if the response has a 4xx status code
+      #
+      # @raise [ContextIO::Error::ClientError] If the response has a 4xx status
+      #   code.
+      # @raise [ContextIO::Error::BadRequest] If the response has a 400 status
+      #   code.
+      # @raise [ContextIO::Error::Unauthorized] If the response has a 401 status
+      #   code.
+      # @raise [ContextIO::Error::PaymentRequired] If the response has a 402
+      #   status code.
+      # @raise [ContextIO::Error::Forbidden] If the response has a 403 status
+      #   code.
+      # @raise [ContextIO::Error::NotFound] If the response has a 404 status
+      #   code.
+      #
+      # @return [void]
+      def on_complete(env)
+        case env[:status].to_i
+        when 400
+          raise ContextIO::Error::BadRequest.new(error_body(env[:body]), env[:response_headers])
+        when 401
+          raise ContextIO::Error::Unauthorized.new(error_body(env[:body]), env[:response_headers])
+        when 402
+          raise ContextIO::Error::PaymentRequired.new(error_body(env[:body]), env[:response_headers])
+        when 403
+          raise ContextIO::Error::Forbidden.new(error_body(env[:body]), env[:response_headers])
+        when 404
+          raise ContextIO::Error::NotFound.new(error_body(env[:body]), env[:response_headers])
+        end
+      end
+
+      private
+
+      # @return [String] The error message if one is defines, or an empty
+      #   string.
+      def error_body(body)
+        if body && body['type'] == 'error' && body['value']
+          body['value']
+        else
+          ''
+        end
+      end
+    end
+  end
+end
+

data/lib/context-io/response/raise_server_error.rb

@@ -0,0 +1,32 @@
+require 'faraday'
+require 'context-io/error/internal_server_error'
+require 'context-io/error/service_unavailable'
+
+module ContextIO
+  module Response
+    # Faraday middleware for raising errors on 5xx status codes
+    #
+    # @api private
+    class RaiseServerError < Faraday::Response::Middleware
+      # Raise an error if the response has a 5xx status code
+      #
+      # @raise [ContextIO::Error::ServerError] If the response has a 5xx status
+      #   code.
+      # @raise [ContextIO::Error::InternalServerError] If the response has a 500
+      #   status code.
+      # @raise [ContextIO::Error::ServiceUnavailable] If the response has a 503
+      #   status code.
+      #
+      # @return [void]
+      def on_complete(env)
+        case env[:status].to_i
+        when 500
+          raise ContextIO::Error::InternalServerError.new('Something is technically wrong.', env[:response_headers])
+        when 503
+          raise ContextIO::Error::ServiceUnavailable.new('Could not connect to mail server.', env[:response_headers])
+        end
+      end
+    end
+  end
+end
+

data/lib/context-io/source.rb

@@ -0,0 +1,193 @@
+require 'context-io/resource'
+
+module ContextIO
+  # A message source. Create one of these for each mailbox a user has
+  #
+  # @api public
+  class Source < ContextIO::Resource
+    attr_accessor :label, :authentication_type, :port, :service_level, :username,
+                  :server, :source_type, :sync_period, :use_ssl, :status
+    attr_reader :account_id, :email
+
+    # Public: Get all sources for given account.
+    #
+    # query - An optional Hash (default: {}) containing a query to filter the
+    #         responses. For possible values see Context.IO API documentation.
+    # Returns an Array of Source objects.
+    #
+    # account - Account object or ID
+    def self.all(account, query = {})
+      return [] if account.nil?
+
+      account_id = account.is_a?(Account) ? account.id : account.to_s
+      get("/2.0/accounts/#{account_id}/sources", query).map do |msg|
+        Source.from_json(account_id, msg)
+      end
+    end
+
+    # Find a source for given ID
+    #
+    # @api public
+    #
+    # @param [String] label The label of the source to look up.
+    #
+    # @example Find the source with the labe 'foobar'
+    #   ContextIO::Source.find('abcdef012345', 'foobar')
+    #
+    # @return [Source] The source with the given label.
+    def self.find(account, label)
+      return nil if account.nil? or label.to_s.empty?
+      account_id = account.is_a?(Account) ? account.id : account.to_s
+
+      Source.from_json(account_id, get("/2.0/accounts/#{account_id}/sources/#{label.to_s}"))
+    end
+
+    # Create a Source instance from the JSON returned by the Context.IO server
+    #
+    # @api private
+    #
+    # @param [Hash] The parsed JSON object returned by a Context.IO API request.
+    #   See their documentation for what keys are possible.
+    #
+    # @return [Source] A source with the given attributes.
+    def self.from_json(account_id, json)
+      source = new(account_id, json)
+    end
+
+    def initialize(account_id, attributes = {})
+      raise ArgumentError if account_id.to_s.empty?
+
+      @account_id = account_id.to_s
+      @email = attributes['email']
+      @label = attributes['label'] || ''
+      @authentication_type = attributes['authentication_type']
+      @port = attributes['port'] || 143
+      @service_level = attributes['service_level']
+      @username = attributes['username']
+      @server = attributes['server']
+      @source_type = attributes['type'] || 'IMAP'
+      @sync_period = attributes['sync_period']
+      @use_ssl = attributes['use_ssl'] || false
+      @status = attributes['status']
+      @password = attributes['password']
+      @provider_token = attributes['provider_token']
+      @provider_token_secret = attributes['provider_token_secret']
+      @provider_consumer_key = attributes['provider_consumer_key']
+    end
+
+    # Returns all source's folders.
+    def folders
+      ContextIO::Folder.all(@account_id, @label)
+    end
+
+    # Sends the source data to Context.IO
+    #
+    # If the source has been sent to Context.IO before, this will update
+    # allowed source attributes.
+    #
+    # @api public
+    #
+    # @raise [ArgumentError] If required arguments are missing.
+    #
+    # @example Create a source
+    #   source = ContextIO::Source.new(@account.id, {'email' => 'me@example.com', 'server' => 'imap@example.com',
+    #      'username' => "me", 'use_ssl' => true, 'port' => 143, 'type' => 'IMAP'})
+    #   source.save
+    #
+    # @return [true, false] Whether the save succeeded or not.
+    def save
+      @label.to_s.empty? ? create_record : update_record
+    end
+
+    # Destroys current source object
+    def destroy
+      return false if @label.to_s.empty?
+
+      response = delete("/2.0/accounts/#{@account_id}/sources/#{@label}")
+      @label = '' if response['success']
+
+      response['success']
+    end
+
+    # Update attributes on the Source object and then send them to Context.IO
+    #
+    # @api public
+    #
+    # @param [Hash] attributes The attributes to update. Allowed
+    # attributes are status, sync period, service level, password,
+    # provider token, provider token secret and provider consumer key
+    #
+    # @example Update the Source sync period to one day
+    #   source.update_attributes('sync_period' => '1d')
+    #
+    # @return [true, false] Whether the update succeeded or not.
+    def update_attributes(attributes = {})
+      raise ArgumentError.new("Cannot set attributes on new record") if @label.to_s.empty?
+      
+      attributes.each do |k,v|
+        if ["status", "sync_period", "service_level", "password", "provider_token", "provider_token_secret", "provider_consumer_key"].include? k
+          send("#{k}=", v)
+        end
+      end
+      update_record
+    end
+
+    private
+
+    # Create the Source on Context.IO
+    #
+    # @api private
+    #
+    # @return [true, false] Whether the creation succeeded or not.
+     def create_record
+      if @email.to_s.empty? or @server.to_s.empty? or @username.to_s.empty? or @port.to_s.empty?
+        raise ArgumentError.new("Mandatory arguments are not set")
+      end
+
+      params = {}
+      params['email'] = @email.to_s
+      params['server'] = @server.to_s
+      params['username'] = @username.to_s
+      params['use_ssl'] = @use_ssl.to_s
+      params['port'] = @port.to_s
+      params['type'] = @source_type.to_s
+
+      # Optional parameters
+      params['service_level'] = @service_level if @service_level
+      params['sync_period'] = @sync_period if @sync_period
+      params['password'] = @password if @password
+      params['provider_token'] = @provider_token if @provider_token
+      params['provider_token_secret'] = @provider_token_secret if @provider_token_secret
+      params['provider_consumer_key'] = @provider_consumer_key if @provider_consumer_key
+
+      response = post("/2.0/accounts/#{@account_id}/sources", params)
+      response['success']
+    end
+
+    # Update existing Source on Context.IO
+    #
+    # Only sends the status, sync period, service level, password,
+    # provider token, provider token secret and provider consumer key
+    # as they are the only attributes the Context.IO API allows to be updated.
+    #
+    # @api private
+    #
+    # @return [true, false] Whether the update succeeded or not.
+    def update_record
+      return false if @label.to_s.empty?
+
+      atts = {}
+
+      atts["status"] = @status if @status
+      atts["sync_period"] = @sync_period if @sync_period
+      atts["service_level"] = @service_level if @service_level
+      atts["password"] = @password if @password
+      atts["provider_token"] = @provider_token if @provider_token
+      atts["provider_token_secret"] = @provider_token_secret if @provider_token_secret
+      atts["provider_consumer_key"] = @provider_consumer_key if @provider_consumer_key
+
+      response = post("/2.0/accounts/#{@account_id}/sources/#{@label}", atts)
+      response['success']
+    end
+  end
+end

data/lib/context-io/version.rb

@@ -0,0 +1,7 @@
+module ContextIO
+  # The ContextIO version. Follows Semantic Versioning.
+  #
+  # @see http://semver.org
+  VERSION = '0.0.1'
+end
+

data/spec/account_spec.rb

@@ -0,0 +1,247 @@
+require 'spec_helper'
+
+describe ContextIO::Account do
+  let(:existing_account) do
+    stub_request(:post, 'https://api.context.io/2.0/accounts').
+      to_return(
+        :body => '{
+          "success": true,
+          "id": "1234567890abcdef",
+          "resource_url": "https://api.context.io/2.0/accounts/1234567890abcdef"
+        }')
+    account = ContextIO::Account.new(:email => 'foo@bar.com')
+    account.save
+
+    account
+  end
+  describe '.all' do
+    before(:each) do
+      json_accs = File.read(File.expand_path(File.join(File.dirname(__FILE__), "fixtures", "accounts.json")))
+      @stub = stub_request(:get, 'https://api.context.io/2.0/accounts').to_return(:body => json_accs)
+    end
+
+    it 'returns an array of Account objects' do
+      accounts = ContextIO::Account.all
+      accounts.first.should be_a(ContextIO::Account)
+    end
+
+    it 'calls the API request' do
+      ContextIO::Account.all
+
+      @stub.should have_been_requested
+    end
+
+    it 'sets the attributes on the Account objects' do
+      ContextIO::Account.all.first.id.should == 'abcdef0123456789'
+    end
+
+    it 'sends a query if one is given' do
+      @stub = @stub.with(:query => {
+        :email => 'me@example.com',
+        :status => 'OK',
+        :status_ok => '1',
+        :limit => '1',
+        :offset => '0'
+      })
+
+      ContextIO::Account.all(
+        :email => 'me@example.com',
+        :status => :ok,
+        :status_ok => true,
+        :limit => 1,
+        :offset => 0
+      )
+
+      @stub.should have_been_requested
+    end
+  end
+
+  describe '.find' do
+    before(:each) do
+      @stub = stub_request(:get, 'https://api.context.io/2.0/accounts/abcdef0123456789').to_return(
+        :body => '{
+          "id": "abcdef0123456789",
+          "username": "me.example.com_1234567890abcdef",
+          "created": 1234567890,
+          "suspended": 0,
+          "email_addresses": [ "me@example.com" ],
+          "first_name": "John",
+          "last_name": "Doe",
+          "password_expired": 0,
+          "sources": [{
+            "server": "mail.example.com",
+            "label": "me::mail.example.com",
+            "username": "me",
+            "port": 993,
+            "authentication_type": "password",
+            "use_ssl": true,
+            "sync_period": "1d",
+            "status": "OK",
+            "service_level": "pro",
+            "type": "imap"
+          }]
+        }'
+      )
+    end
+
+    it 'returns an instance of Account' do
+      ContextIO::Account.find('abcdef0123456789').should be_a(ContextIO::Account)
+    end
+
+    it 'calls the API request' do
+      ContextIO::Account.find('abcdef0123456789')
+
+      @stub.should have_been_requested
+    end
+
+    it 'sets the attributes on the Account object' do
+      ContextIO::Account.find('abcdef0123456789').id.should == 'abcdef0123456789'
+    end
+  end
+
+  describe '.new' do
+    it 'returns an instance of Account' do
+      ContextIO::Account.new.should be_a(ContextIO::Account)
+    end
+
+    it 'sets the given attributes on the Account object' do
+      account = ContextIO::Account.new(:first_name => 'John')
+      account.first_name.should == 'John'
+    end
+  end
+
+  describe '#save' do
+
+
+    it 'returns true if the save was successful' do
+      @stub = stub_request(:post, 'https://api.context.io/2.0/accounts').
+        with(:body => { :email => 'me@example.com' }).
+        to_return(
+        :body => '{
+          "success": true,
+          "id": "abcdef0123456789",
+          "resource_url": "https://api.context.io/2.0/accounts/abcdef0123456789"
+        }'
+      )
+
+      account = ContextIO::Account.new(:email => 'me@example.com')
+
+      account.save.should be_true
+    end
+
+    it 'returns false if the save was unsuccessful' do
+      @stub = stub_request(:post, 'https://api.context.io/2.0/accounts').
+        with(:body => { :email => 'me@example.com' }).
+        to_return(
+        :body => '{
+          "success": false
+        }'
+      )
+
+      account = ContextIO::Account.new(:email => 'me@example.com')
+
+      account.save.should be_false
+    end
+
+    context 'for a new account' do
+      before(:each) do
+        @stub = stub_request(:post, 'https://api.context.io/2.0/accounts').
+          with(:body => { :email => 'me@example.com' }).
+          to_return(
+          :body => '{
+            "success": true,
+            "id": "abcdef0123456789",
+            "resource_url": "https://api.context.io/2.0/accounts/abcdef0123456789"
+          }'
+        )
+      end
+
+      it 'calls the API request' do
+        ContextIO::Account.new(:email => 'me@example.com').save
+
+        @stub.should have_been_requested
+      end
+
+      it 'sets the ID of the account' do
+        account = ContextIO::Account.new(:email => 'me@example.com')
+        account.save
+        account.id.should == 'abcdef0123456789'
+      end
+    end
+
+    context 'for an existing account' do
+      it 'calls the API request' do
+        @stub = stub_request(:put,
+          'https://api.context.io/2.0/accounts/1234567890abcdef').
+          with(:query => { :first_name => 'John' }).
+          to_return(
+          :body => '{
+            "success": true
+          }'
+        )
+
+        existing_account.first_name = 'John'
+        existing_account.save
+
+        @stub.should have_been_requested
+      end
+    end
+  end
+
+  describe '#update_attributes' do
+    it 'calls the API request' do
+      @stub = stub_request(:put,
+        'https://api.context.io/2.0/accounts/1234567890abcdef').
+        with(:query => { :first_name => 'John' }).
+        to_return(
+        :body => '{
+          "success": true
+        }'
+      )
+
+      existing_account.update_attributes(:first_name => 'John')
+
+      @stub.should have_been_requested
+    end
+
+    it 'returns true if the update was successful' do
+      stub_request(:put, 'https://api.context.io/2.0/accounts/1234567890abcdef').
+        with(:query => { :first_name => 'John' }).
+        to_return(
+        :body => '{
+          "success": true
+        }'
+      )
+
+      existing_account.update_attributes(:first_name => 'John').should be_true
+    end
+
+    it 'returns false if the update was unsuccessful' do
+      stub_request(:put, 'https://api.context.io/2.0/accounts/1234567890abcdef').
+        with(:query => { :first_name => 'John' }).
+        to_return(
+        :body => '{
+          "success": false
+        }'
+      )
+
+      existing_account.update_attributes(:first_name => 'John').should be_false
+    end
+
+
+    it 'sets the attributes on the account object' do
+      stub_request(:put, 'https://api.context.io/2.0/accounts/1234567890abcdef').
+        with(:query => { :first_name => 'John' }).
+        to_return(
+        :body => '{
+          "success": true
+        }'
+      )
+
+      existing_account.update_attributes(:first_name => 'John')
+
+      existing_account.first_name.should == 'John'
+    end
+  end
+end
+