context-io 0.0.1

data/lib/context-io/folder.rb

@@ -0,0 +1,90 @@
+require "context-io/resource"
+
+module ContextIO
+  class Folder < ContextIO::Resource
+    # @api public
+    # @return [String] The (Context.IO) ID of the account this folder belongs
+    #   to, as a hexadecimal string.
+    attr_reader :account_id
+
+    # @api public
+    # @return [String] The label of the source this folder belongs to.
+    attr_reader :source_label
+
+    # @api public
+    # @return [String] The full name of the folder. This includes the name of
+    #   parent folders.
+    attr_reader :name
+
+    # @api public
+    # @return [String] The folder hierarchy delimiter.
+    #
+    # @example Get the folder name and not the entire path.
+    #   folder.name.split(folder.delim).last
+    attr_reader :delim
+
+    # @api public
+    # @return [Integer] The number of messages in the folder.
+    attr_reader :nb_messages
+
+    # @api public
+    # @return [true, false] Whether this folder is included when Context.IO
+    #   syncs with the source.
+    attr_reader :included_in_sync
+
+    # Get all folders for a given source and account
+    #
+    # @api public
+    #
+    # @overload all(account_id, source_label)
+    #   @param [#to_s] account_id The account ID
+    #   @param [#to_s] source_label The source label
+    # @overload all(source)
+    #   @param [ContextIO::Source] source The source object
+    #
+    # @example Find a the folders on a given source.
+    #   ContextIO::Folder.all(source)
+    #
+    # @return [Array<ContextIO::Folder>] The folders in the given source.
+    def self.all(*args)
+      if args.length == 1
+        account_id = args.first.account_id
+        source_label = args.first.label
+      elsif args.length == 2
+        account_id = args.first.to_s
+        source_label = args.last.to_s
+      else
+        raise ArgumentError, "Expecting one or two arguments, got #{args.length}"
+      end
+
+      get("/2.0/accounts/#{account_id}/sources/#{source_label}/folders").map do |msg|
+        Folder.from_json(account_id, source_label, msg)
+      end
+    end
+
+    # Create a Folder with the JSON data from Context.IO
+    #
+    # @api private
+    #
+    # @param [String] account_id The account ID the source belongs to.
+    # @param [String] source_label The label of the source this folder belongs
+    #   to.
+    # @param [Hash] json The parsed JSON object returned by a Context.IO API
+    #   request. See their documentation for possible keys.
+    #
+    # @return [ContextIO::Folder] A Folder with the given attributes.
+    def self.from_json(account_id, source_label, json)
+      folder = new
+      folder.instance_eval do
+        @account_id = account_id
+        @source_label = source_label
+        @name = json['name']
+        @delim = json['delim']
+        @nb_messages = json['nb_messages']
+        @included_in_sync = json['included_in_sync']
+      end
+
+      folder
+    end
+  end
+end

data/lib/context-io/message.rb

@@ -0,0 +1,160 @@
+require "context-io/resource"
+
+module ContextIO
+  class Message < Resource
+    attr_accessor :message_id, :account_id, :sources, :from, :to, :cc, :subject, :date, :folders, :files
+    attr_reader :raw_data
+
+    # Public: Get all messages 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 Message 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}/messages", query).map do |msg|
+        Message.from_json(account_id, msg)
+      end
+    end
+
+    def self.find(account, message_id)
+      return nil if account.nil? or message_id.nil?
+      account_id = account.is_a?(Account) ? account.id : account.to_s
+
+      Message.from_json(account_id, get("/2.0/accounts/#{account_id}/messages/#{message_id}"))
+    end
+
+    # Internal: Create an Message instance from the JSON returned by the
+    # Context.IO server.
+    #
+    # json - The parsed JSON returned by the Context.IO server. See their
+    #        documentation for what keys are possible.
+    #
+    # Returns a ContextIO::Message instance.
+    def self.from_json(account_id, json_msg)
+      message = new(account_id, json_msg)
+      message.message_id = json_msg["message_id"]
+      message.subject = json_msg["subject"]
+      message.date = Time.at json_msg["date"]
+      message.sources = json_msg["sources"]
+      message.from = json_msg["addresses"]["from"]
+      message.to = json_msg["addresses"]["to"]
+      message.cc = json_msg["addresses"]["cc"]
+      message.folders = json_msg["folders"]
+      message.files = json_msg["files"]
+      message
+    end
+
+    # Internal: Returns ContextIO::Message object
+    #
+    # raw_data - The parse JSON returned by the Context.IO server.
+    def initialize(account_id, raw_data)
+      @account_id = account_id
+      @raw_data = raw_data
+      @body = {}
+    end
+
+    # Public: Returns message body. Data is lazy loaded. Message
+    # body fetched from Context.IO server contain plain text and html
+    # format and both formats are stored.
+    #
+    # format - String determining required format of message body.
+    # Allowed values are :plain and :html. Default value is :plain.
+    def body(format = :plain)
+      if @body.empty?
+        get("#{url}/body").each do |b|
+          @body[b["type"]] = b["content"]
+        end
+      end
+      @body["text/#{format}"]
+    end
+
+    # Public: Returns message headers. Data is lazy loaded.
+    def headers
+      @headers ||= get("#{url}/headers")
+    end
+
+    # Public: Returns message flags.
+    def flags
+      get("#{url}/flags")
+    end
+
+    def read!
+      flag("seen" => true)
+    end
+
+    def unread!
+      flag("seen" => false)
+    end
+
+    def flagged!
+      flag("flagged" => true)
+    end
+
+    def unflagged!
+      flag("flagged" => false)
+    end
+
+    def answered!
+      flag("answered" => true)
+    end
+
+    def unanswered!
+      flag("answered" => false)
+    end
+
+    def draft!
+      flag("draft" => true)
+    end
+
+    def undraft!
+      flag("draft" => false)
+    end
+
+    def delete!
+      flag("deleted" => true)
+    end
+
+    def undelete!
+      flag("deleted" => false)
+    end
+
+    # Public: Returns array of messages of the thread a given message is in.
+    def thread
+      get("#{url}/thread")["messages"].map do |m|
+        Message.from_json(account_id, m)
+      end
+    end
+
+    def copy(folder_name, destination_source = nil)
+      copy_move(folder_name, false, destination_source)
+    end
+
+    def move(folder_name, destination_source = nil)
+      copy_move(folder_name, true, destination_source)
+    end
+
+    private
+    def url
+      "/2.0/accounts/#{account_id}/messages/#{message_id}"
+    end
+
+    def copy_move(folder_name, move, destination_source)
+      raise ArgumentError.new("Valid values for 'move' flag are 1 and 0") unless [true, false].include? move
+      destination = folder_name.to_s
+      raise ArgumentError.new("Destination folder cannot be empty") if destination.empty?
+      options = {:dst_folder => destination, :move => move ? 1 :0}
+      options[:dst_source] = destination_source if destination_source
+      post(url, options)['success']
+    end
+
+    def flag(value = {})
+      response = post("#{url}/flags", value)
+      response["success"]
+    end
+  end
+end

data/lib/context-io/oauth_provider.rb

@@ -0,0 +1,84 @@
+module ContextIO
+  class OAuthProvider < Resource
+    # @api public
+    # @return [String] The identification of the OAuth provider. This must be
+    #   either "GMAIL" or "GOOGLEAPPSMARKETPLACE".
+    attr_reader :type
+
+    # @api public
+    # @return [String] The OAuth consumer key.
+    attr_reader :consumer_key
+
+    # @api public
+    # @return [String] The OAuth consumer secret.
+    attr_reader :consumer_secret
+
+    # Get all OAuth providers configured
+    #
+    # @api public
+    #
+    # @return [Array<ContextIO::OAuthProvider>] All OAuth providers.
+    def self.all
+      get('/2.0/oauth_providers').map { |provider| from_json(provider) }
+    end
+
+    # Create an OAuth provider
+    #
+    # @api public
+    #
+    # @param ['GMAIL', 'GOOGLEAPPSMARKETPLACE', :gmail, :googleappsmarketplace]
+    #   type The identification of the OAuth provider.
+    # @param [#to_s] consumer_key The OAuth consumer key.
+    # @param [#to_s] consumer_secret The OAuth consumer secret.
+    #
+    # @return [true, false] Whether the create succeeded or not.
+    def self.create(type, consumer_key, consumer_secret)
+      post('/2.0/oauth_providers', {
+        :type => type.to_s.upcase,
+        :provider_consumer_key => consumer_key.to_s,
+        :provider_consumer_secret => consumer_secret.to_s
+      })['success']
+    end
+
+    # Retrieve an OAuth provider
+    #
+    # @api public
+    #
+    # @param [#to_s] consumer_key The OAuth consumer key.
+    #
+    # @return [ContextIO::OAuthProvider] The OAuth provider.
+    def self.find(consumer_key)
+      from_json(get("/2.0/oauth_providers/#{consumer_key}"))
+    end
+
+    # Destroy the OAuth provider
+    #
+    # @api public
+    #
+    # @return [true, false] Whether the destroy was successful or not.
+    def destroy
+      delete("/2.0/oauth_providers/#@consumer_key")['success']
+    end
+
+    # Create an OAuth provider with the JSON data from Context.IO.
+    #
+    # @api private
+    #
+    # @param [Hash] json The parsed JSON object returned by a Context.IO API
+    #   request. See their documentation for possible keys.
+    #
+    # @return [ContextIO::OAuthProvider] An OAuth provider with the given
+    #   attributes.
+    def self.from_json(json)
+      provider = new
+      provider.instance_eval do
+        @type = json['type']
+        @consumer_key = json['provider_consumer_key']
+        @consumer_secret = json['provider_consumer_secret']
+      end
+
+      provider
+    end
+  end
+end
+

data/lib/context-io/request.rb

@@ -0,0 +1,70 @@
+module ContextIO
+  # Methods for sending HTTP requests
+  #
+  # @api private
+  module Request
+    # Perform an HTTP DELETE request
+    #
+    # @param [String] path The path to request.
+    # @param [Hash] params Parameters to put in the query part of the URL
+    #
+    # @return [Hash, Array, Object] The parsed JSON response.
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+    # Perform an HTTP GET request
+    #
+    # @param [String] path The path to request.
+    # @param [Hash] params The parameters to put in the query part of the URL.
+    #
+    # @return [Hash, Array, Object] The parsed JSON response.
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    # Perform an HTTP POST request
+    #
+    # @param [String] path The path to request.
+    # @param [Hash] params The parameters to put in the body of the request.
+    #
+    # @return [Hash, Array, Object] The parsed JSON response.
+    def post(path, params={})
+      request(:post, path, params)
+    end
+
+    # Perform an HTTP PUT request
+    #
+    # @param [String] path The path to request.
+    # @param [Hash] The parameters to put in the body of the request.
+    #
+    # @return [Hash, Array, Object] The parsed JSON response.
+    def put(path, params={})
+      request(:put, path, params)
+    end
+
+    # Perform an HTTP request
+    #
+    # @param [:delete, :get, :put, :post] method The HTTP method to send.
+    # @param [String] path The path to request.
+    # @param [Hash] The parameters to put in the query part of the URL (for
+    #   DELETE and GET requests) or in the body of the request (for POST and PUT
+    #   requests).
+    #
+    # @return [Hash, Array, Object] The parsed JSON response.
+    def request(method, path, params)
+      response = connection(params.delete(:raw)).send(method) do |request|
+        case method.to_sym
+        when :delete, :get, :put
+          request.url(path, params)
+        when :post
+          request.path = path
+          request.body = params unless params.empty?
+        end
+      end
+
+      response.body
+    end
+  end
+end
+

data/lib/context-io/request/oauth.rb

@@ -0,0 +1,44 @@
+require 'faraday'
+require 'simple_oauth'
+
+module ContextIO
+  module Request
+    # Faraday middleware for handling the OAuth header
+    #
+    # @api private
+    class ContextIOOAuth < Faraday::Middleware
+      # Add the OAuth header
+      #
+      # @param [Hash] env The Rack environment
+      #
+      # @return [Array] The Rack response
+      def call(env)
+        params = env[:body] || {}
+        signature_params = params
+        params.each do |key, value|
+          signature_params = {} if value.respond_to?(:content_type)
+        end
+        header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
+        env[:request_headers]['Authorization'] = header.to_s
+
+        @app.call(env)
+      end
+
+      # Initialize the OAuth middleware
+      #
+      # @param [#call] The next Rack middleware of app to call.
+      # @param [Hash] options The authentication options to use for OAuth
+      #   authentication.
+      # @option options [String] :consumer_key The OAuth consumer key
+      # @option options [String] :consumer_secret The OAuth consumer secret
+      # @option options [nil] :token The OAuth token, should be nil since
+      #   Context.IO doesn't support three-legged authentication.
+      # @option options [nil] :token_secret The Oauth token secret, should be
+      #   nil since Context.IO doesn't support three-legged authentication.
+      def initialize(app, options)
+        @app, @options = app, options
+      end
+    end
+  end
+end
+