yammer-client 0.1.2 → 0.1.3

data/lib/yammer/api/search.rb

@@ -7,7 +7,7 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param [Hash] opts the options to fetch a thread with
       # @option opts [Integer] :num_per_page
       # @option opts [Integer] :page

data/lib/yammer/api/topic.rb

@@ -7,7 +7,7 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param id [Integer]
       # @param [Hash] opts the options to fetch a thread with
       # @option opts [Integer] :is_followed_by

data/lib/yammer/api/user.rb

@@ -6,7 +6,7 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param  opts [Hash] A customizable set of options.
       # @option opts [String] :email
       # @option opts [String] :full_name
@@ -39,7 +39,7 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param  opts [Hash] A customizable set of options.
       # @option opts [String] :email
       # @option opts [String] :full_name
@@ -72,7 +72,7 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param id [Integer, String] A Yammer user ID
       # @example Delete user with ID 2
       #   Yammer.delete_user(2)
@@ -84,7 +84,7 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param id [Integer, String] A Yammer user ID
       # @example Fetch data user with ID 2
       #   Yammer.get_user(2)
@@ -96,7 +96,7 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param email [Integer, String] A Yammer user ID
       # @example Fetch data user with email `thekev@yammer.com`
       #   Yammer.get_user_by_email('thekev@yammer.com')
@@ -108,7 +108,7 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @example Fetch data for the authenticated user
       #   Yammer.current_user
       def current_user
@@ -119,10 +119,10 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param  opts [Hash] A customizable set of opts.
       # @option opts [Integer] :page
-      # @example Fetch users from the autheticated user's network
+      # @example Fetch users from the authenticated user's network
       #   Yammer.all_users
       def all_users(opts={})
         get("/api/v1/users", opts)
@@ -131,25 +131,25 @@ module Yammer
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param  opts [Hash] A customizable set of opts.
       # @option opts [Boolean] :full
-      # @example Fetch users from the autheticated user's network
+      # @example Fetch users from the authenticated user's network following user whose ID is provided
       #   Yammer.users_following(1)
-      def users_following(id, opts={})
-        get("/api/v1/users/following/", opts)
+      def users_following(id)
+        get("/api/v1/users/following/#{id}")
       end
 
       # @rate_limited Yes
       # @authentication Requires user context
       # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
-      # @return [Yammer::Response]
+      # @return [Yammer::ApiResponse]
       # @param  opts [Hash] A customizable set of opts.
       # @option opts [Boolean] :full
-      # @example Fetch users from the autheticated user's network
-      #   Yammer.users_following(1)
-      def users_followed(id, opts={})
-        get("/api/v1/users/followed_by", opts)
+      # @example Fetch users from the authenticated user's network followed by the user whose ID is provided
+      #   Yammer.users_followed(1)
+      def users_followed_by(id)
+        get("/api/v1/users/followed_by/#{id}")
       end
     end
   end

data/lib/yammer/api_handler.rb

@@ -0,0 +1,15 @@
+module Yammer
+  module ApiHandler
+    def api_handler
+      @api_handler ||= establish_api_handler
+    end
+
+    def establish_api_handler(opts={})
+      Yammer::Client.new(opts)
+    end
+
+    def reset_api_handler!
+      @api_handler = nil
+    end
+  end
+end

data/lib/yammer/{response.rb → api_response.rb}

@@ -1,12 +1,12 @@
 module Yammer
-  class Response
+  class ApiResponse
 
-    attr_reader :code, :body, :headers
+    attr_reader :code, :headers
 
-    def initialize(response)
-      @headers = response.header
-      @body    = response.body
-      @code    = response.code.to_i
+    def initialize(headers, body, code)
+      @headers = headers
+      @body    = body
+      @code    = code.to_i
     end
 
     def raw_body

data/lib/yammer/base.rb

@@ -1,6 +1,7 @@
 module Yammer
   class Base
     class << self
+      include ApiHandler
 
       # Returns the non-qualified class name
       # @!scope class
@@ -32,7 +33,7 @@ module Yammer
         return unless identity_map
         attributes = identity_map.get("#{base_name}_#{id}")
         unless attributes
-          result = Yammer.send("get_#{base_name}", id)
+          result = api_handler.send("get_#{base_name}", id)
           attributes = result.empty? ? nil : result.body
           unless attributes.empty?
             identity_map.put("#{base_name}_#{id}", attributes)
@@ -48,16 +49,16 @@ module Yammer
 
       # Returns a hash of all attributes that are meant to trigger an HTTP request 
       # @!scope class
-      def fetchable_attrs
-        @fetchable_keys ||= {}
+      def model_attributes
+        @model_attributes ||= {}
       end
 
     protected
 
       def attr_accessor_deffered(*symbols)
         symbols.each do |key|
-          # track attributes the trigger fetch
-          fetchable_attrs[key] = false
+          # track attributes that should trigger a fetch
+          model_attributes[key] = false
 
           # getter
           define_method(key.to_s) do
@@ -82,16 +83,23 @@ module Yammer
     attr_reader :id, :attrs
 
     def initialize(props={})
+      @klass               = self.class
       @modified_attributes = {}
       @new_record          = true
       @loaded              = false
       @attrs               = props
       self.id              = @attrs.delete(:id)
       self.update(@attrs)
+
+      yield self if block_given?
+    end
+
+    def api_handler
+      @klass.api_handler
     end
 
     def base_name
-      self.class.base_name
+      @klass.base_name
     end
 
     def new_record?
@@ -115,7 +123,7 @@ module Yammer
     end
 
     def load!
-      @attrs = self.class.fetch(@id)
+      @attrs = @klass.fetch(@id)
       @loaded = true
       update(@attrs)
       self
@@ -130,9 +138,9 @@ module Yammer
       return self if ((persisted? && @modified_attributes.empty?) || @attrs.empty?)
 
       result = if new_record?
-        Yammer.send("create_#{base_name}", @attrs)
+        api_handler.send("create_#{base_name}", @attrs)
       else
-        Yammer.send("update_#{base_name}", @id, @modified_attributes)
+        api_handler.send("update_#{base_name}", @id, @modified_attributes)
       end
       @modified_attributes = {}
       self
@@ -140,7 +148,7 @@ module Yammer
 
     def delete!
       return if new_record?
-      result = Yammer.send("delete_#{base_name}", @id)
+      result = api_handler.send("delete_#{base_name}", @id)
       result.success?
     end
 
@@ -177,7 +185,7 @@ module Yammer
         send("#{key}=", value)
       end
       if persisted? && !loaded?
-        @loaded = self.class.fetchable_attrs.keys.inject(true) do |result, key|
+        @loaded = @klass.model_attributes.keys.inject(true) do |result, key|
           result && @attrs.has_key?(key)
         end
       end

data/lib/yammer/client.rb

@@ -1,7 +1,6 @@
-require 'multi_json'
-require 'yammer/configurable'
-require 'yammer/http_connection'
 require 'yammer/api'
+require 'yammer/configurable'
+require 'yammer/http_adapter'
 
 module Yammer
   class Client
@@ -16,28 +15,24 @@ module Yammer
     include Yammer::Api::Search
     include Yammer::Api::Notification
     include Yammer::Api::Autocomplete
+    include Yammer::Api::PendingAttachment
+ 
+    attr_reader :site_url, :headers, :connection_options
 
-    attr_writer :connection_options
-    attr_accessor :site_url, :http_adapter
+    attr_accessor :client_id, :client_secret, :access_token
 
     def initialize(opts={})
       Yammer::Configurable.keys.each do |key|
-        instance_variable_set(:"@#{key}", opts.fetch(key, Yammer.instance_variable_get(:"@#{key}")))
+        case key
+        when :headers, :connection_options
+          value = Yammer.instance_variable_get(:"@#{key}").merge(opts.fetch(key, {}))
+        else
+          value = opts.fetch(key, Yammer.instance_variable_get(:"@#{key}"))
+        end
+        instance_variable_set(:"@#{key}", value)
       end
     end
 
-    # @return [Hash] the options used to setup the http connection
-    def connection_options
-      @connection_options ||= {}
-    end
-
-    # set the url to be used for creating an http connection
-    # @param url [string]
-    def site_url=(url)
-      @connection = nil
-      @site_url = url
-    end
-
     # (see #request)
     # @note makes a GET request
     def get(path, params={})
@@ -64,38 +59,28 @@ module Yammer
 
   private
 
+    # returns an instance of the http adapter
+    # if none is specified, the default is Yammer::HttpConnection
+    # @!visibility private
+    def http_client
+      @http_client ||= @http_adapter.new(@site_url, @connection_options)
+    end
+
     # Makes an HTTP request using the provided parameters
     # @raise [Yammer::Error::Unauthorized]
     # @param method [string]
     # @param path [string]
     # @param params [Hash]
     # @param opts [Hash]
-    # @return [Yammer::Response]
+    # @return [Yammer::ApiResponse]
     # @!visibility private
-    def request(method, path, params={}, opts={})
-      headers  = opts.fetch(:headers, {}).merge({
-        'Authorization' => "Bearer #{@access_token}"
-      })
-      response = connection.send_request(method, path, {
-        :params  => params,
-        :headers => headers
+    def request(method, path, params={})
+      @headers['Authorization'] ||= "Bearer #{@access_token}"
+      result = http_client.send_request(method, path, {
+        :params => params,
+        :headers => @headers
       })
-      result = Yammer::Response.new(response)
-      status = result.code
-      case status
-      when 200...400
-        result
-      else
-        message = result.empty? ? '' : result.body[:response][:message]
-        raise Yammer::Error.from_status(status).new(message)
-      end
-    end
-
-    # returns an instance of the http adapter
-    # if none is specified, the default is Yammer::HttpConnection
-    # @!visibility private
-    def connection
-      @connection ||= @http_adapter.new(@site_url, connection_options)
+      result
     end
   end
 end

data/lib/yammer/configurable.rb

@@ -1,11 +1,13 @@
+require 'yammer/http_adapter'
+
 module Yammer
   module Configurable
 
     ENDPOINT = 'https://www.yammer.com' unless defined? ENDPOINT
-    HTTP_CONNECTION = Yammer::HttpConnection unless defined? HTTP_CONNECTION
+    HTTP_ADAPTER = Yammer::HttpAdapter unless defined? HTTP_CONNECTION
 
-    attr_accessor :hostname, :client_id, :client_secret, :access_token, :site_url, :http_adapter,
-    :connection_options
+    attr_accessor :client_id, :client_secret, :access_token, :site_url,
+    :connection_options, :headers, :http_adapter
 
     # Return a hash with the default options
     # @return [Hash]
@@ -15,14 +17,18 @@ module Yammer
         :client_id          => ENV['YAMMER_CLIENT_ID'],
         :client_secret      => ENV['YAMMER_CLIENT_SECRET'],
         :access_token       => ENV['YAMMER_ACCESS_TOKEN'],
-        :http_adapter       => HTTP_CONNECTION,
-        :connection_options => { :max_redirects => 5, :use_ssl => true }
+        :http_adapter       => HTTP_ADAPTER,
+        :connection_options => { :max_redirects => 5, :verify_ssl => true },
+        :headers            => {
+          'Accept'     => 'application/json',
+          'User-Agent' => "Yammer Ruby Gem #{Yammer::Version}"
+        }
       }
     end
 
-    # @return [Array<String>
+    # @return [Array<String>]
     def self.keys
-      Yammer::Configurable.default_options.keys
+      self.default_options.keys
     end
 
     # @return [Hash]
@@ -39,7 +45,7 @@ module Yammer
 
     # Convenience method to allow configuration options to be set in a block
     def configure
-      yield self
+      yield self if block_given?
       self
     end
   end

data/lib/yammer/group.rb

@@ -7,7 +7,7 @@ module Yammer
 
     # @!scope class
     def self.create(params={})
-      result = Yammer.create_group(params)
+      result = api_handler.create_group(params)
     end
   end
 end

data/lib/yammer/group_membership.rb

@@ -5,7 +5,7 @@ module Yammer
 
     # @!scope class
     def self.create(id)
-      Yammer.create_group_membership(id)
+      api_handler.create_group_membership(id)
     end
   end
 end

data/lib/yammer/http_adapter.rb

@@ -0,0 +1,74 @@
+require 'restclient'
+require 'multi_json'
+require 'addressable/uri'
+
+module Yammer
+  class HttpAdapter
+
+    attr_reader :site_url, :connection_options
+
+    def initialize(site_url, opts={})
+      unless site_url =~ /^https?/
+        raise ArgumentError, "site_url must include either http or https scheme"
+      end
+      @site_url = site_url
+      @connection_options = opts
+    end
+
+    # set the url to be used for creating an http connection
+    # @param url [string]
+    def site_url=(url)
+      @site_url = url
+      @host     = nil
+      @scheme   = nil
+    end
+
+    def host
+      @host ||= parsed_url.host
+    end
+
+    def scheme
+      @scheme ||= parsed_url.scheme
+    end
+
+    def absolute_url(path='')
+      "#{@site_url}#{path}"
+    end
+
+    def connection_options=(opts)
+      raise ArgumentError, 'expected Hash' unless opts.is_a?(Hash)
+      @connection_options = opts
+    end
+
+    def send_request(method, path, opts={})
+      params  = opts.fetch(:params, {})
+
+      req_opts = self.connection_options.merge({
+        :method  => method,
+        :headers => opts.fetch(:headers, {})
+      })
+
+      case method
+      when :get, :delete
+        query = Addressable::URI.form_encode(params)
+        normalized_path = query.empty? ? path : [path, query].join("?")
+        req_opts[:url]  = absolute_url(normalized_path)
+      when :post, :put
+        req_opts[:payload] = params
+        req_opts[:url]     = absolute_url(path)
+      else
+        raise "Unsupported HTTP method, #{method}"
+      end
+
+      resp = RestClient::Request.execute(req_opts)
+
+      result = Yammer::ApiResponse.new(resp.headers, resp.body, resp.code)
+    end
+
+  private
+    def parsed_url
+      Addressable::URI.parse(@site_url)
+    end
+
+  end
+end