yam 0.0.6 → 1.0.0

data/lib/yammer/api_handler.rb

@@ -0,0 +1,27 @@
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+# 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 
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
+# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
+# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
+# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
+
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+module Yammer
+  module ApiHandler
+
+    def api_handler
+      establish_api_handler
+    end
+
+    def establish_api_handler(opts={})
+      Yammer::Client.new(opts)
+    end
+
+  end
+end

data/lib/yammer/api_response.rb

@@ -0,0 +1,57 @@
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+# 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 
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
+# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
+# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
+# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
+
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+module Yammer
+  class ApiResponse
+
+    attr_reader :code, :headers
+
+    def initialize(headers, body, code)
+      @headers = headers
+      @body    = body
+      @code    = code.to_i
+    end
+
+    def raw_body
+      @body
+    end
+
+    def body
+      @parsed_body ||= parse(@body)
+    end
+
+    def empty?
+      @body.nil? || @body.strip.empty?
+    end
+
+    def success?
+      @code == 200
+    end
+
+    def created?
+      @code == 201
+    end
+
+  private
+
+    def parse(body)
+      case body
+      when /\A^\s*$\z/, nil
+        nil
+      else
+        MultiJson.load(body, :symbolize_keys => true)
+      end
+    end
+  end
+end

data/lib/yammer/base.rb

@@ -0,0 +1,208 @@
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+# 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 
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
+# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
+# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
+# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
+
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+module Yammer
+  class Base
+    class << self
+      include ApiHandler
+
+      # Returns the non-qualified class name
+      # @!scope class
+      def base_name
+        @base_name ||= begin
+          word = "#{name.split(/::/).last}"
+          word.gsub!(/::/, '/')
+          word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+      end
+
+      # Fetches JSON reprsentation for object model with provided `id`
+      # and returns a model instance with attributes
+      # @return [Yammer::Base]
+      # @param id [Integer]
+      # @!scope class
+      def get(id)
+        attrs = fetch(id)
+        attrs ? new(attrs) : nil
+      end
+
+
+      # @!scope class
+      def fetch(id)
+        return unless identity_map
+        attributes = identity_map.get("#{base_name}_#{id}")
+        unless attributes
+          result = api_handler.send("get_#{base_name}", id)
+          attributes = result.empty? ? nil : result.body
+          unless attributes.empty?
+            identity_map.put("#{base_name}_#{id}", attributes)
+          end
+        end
+        attributes
+      end
+
+      # @!scope class
+      def identity_map
+        @identity_map ||= Yammer::IdentityMap.new
+      end
+
+      # Returns a hash of all attributes that are meant to trigger an HTTP request 
+      # @!scope class
+      def model_attributes
+        @model_attributes ||= {}
+      end
+
+    protected
+
+      def attr_accessor_deffered(*symbols)
+        symbols.each do |key|
+          # track attributes that should trigger a fetch
+          model_attributes[key] = false
+
+          # getter
+          define_method(key.to_s) do
+            load_deferred_attribute!(key)
+            instance_variable_get("@#{key}")
+          end
+
+          # setter
+          define_method("#{key}=") do |value|
+            load_deferred_attribute!(key)
+            if persisted? && loaded?
+              @modified_attributes[key] = value
+            else
+              @attrs[key] = value
+            end
+            instance_variable_set("@#{key}", value)
+          end
+        end
+      end
+    end
+
+    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
+      @klass.base_name
+    end
+
+    def new_record?
+      @new_record
+    end
+
+    def persisted?
+      !new_record?
+    end
+
+    def changes
+      @modified_attributes
+    end
+
+    def modified?
+      !changes.empty?
+    end
+
+    def loaded?
+      @loaded
+    end
+
+    def load!
+      @attrs = @klass.fetch(@id)
+      @loaded = true
+      update(@attrs)
+      self
+    end
+
+    def reload!
+      reset!
+      load!
+    end
+
+    def save
+      return self if ((persisted? && @modified_attributes.empty?) || @attrs.empty?)
+
+      result = if new_record?
+        api_handler.send("create_#{base_name}", @attrs)
+      else
+        api_handler.send("update_#{base_name}", @id, @modified_attributes)
+      end
+      @modified_attributes = {}
+      self
+    end
+
+    def delete!
+      return if new_record?
+      result = api_handler.send("delete_#{base_name}", @id)
+      result.success?
+    end
+
+  private
+
+    def id=(model_id)
+      return if model_id.nil?
+      @id = model_id.to_i
+      @new_record = false
+    end
+
+    # clear the entire class
+    def reset!
+      @modified_attributes = {}
+      @attrs  = {}
+      @new_record = true
+      @loaded = false
+    end
+
+  protected
+    # loads model 
+    def load_deferred_attribute!(key)
+      if @attrs.empty? && persisted? && !loaded?
+        load!
+        if !@attrs.has_key?(key)
+          raise "The key: #{key} appears not to be supported for model: #{self.base_name} \n #{@attrs.keys.inspect}"
+        end
+      end
+    end
+
+    # set all fetchable attributes 
+    def update(attrs={})
+      attrs.each do |key, value|
+        send("#{key}=", value)
+      end
+      if persisted? && !loaded?
+        @loaded = @klass.model_attributes.keys.inject(true) do |result, key|
+          result && @attrs.has_key?(key)
+        end
+      end
+    end
+  end
+end

data/lib/yammer/client.rb

@@ -0,0 +1,100 @@
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+# 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 
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
+# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
+# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
+# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
+
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+require 'yammer/api'
+require 'yammer/configurable'
+require 'yammer/http_adapter'
+
+module Yammer
+  class Client
+
+    include Yammer::Configurable
+    include Yammer::Api::User
+    include Yammer::Api::Group
+    include Yammer::Api::GroupMembership
+    include Yammer::Api::Message
+    include Yammer::Api::Thread
+    include Yammer::Api::Topic
+    include Yammer::Api::Network
+    include Yammer::Api::Search
+    include Yammer::Api::Like
+    include Yammer::Api::Notification
+    include Yammer::Api::Autocomplete
+    include Yammer::Api::Invitation
+    include Yammer::Api::PendingAttachment
+    include Yammer::Api::Subscription
+    include Yammer::Api::OpenGraphObject
+
+    attr_reader :site_url, :default_headers, :connection_options
+
+    attr_accessor :client_id, :client_secret, :access_token
+
+    def initialize(opts={})
+      Yammer::Configurable.keys.each do |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
+
+    # makes a GET request
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    # makes a PUT request
+    def put(path, params={})
+      request(:put, path, params)
+    end
+
+    # makes a POST request
+    def post(path, params={})
+      request(:post, path, params)
+    end
+
+    # makes a DELETE request
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+  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]
+    # @return [Yammer::ApiResponse]
+    # @!visibility private
+    def request(method, path, params={})
+      headers = @default_headers.merge({'Authorization' => "Bearer #{@access_token}"})
+      result = http_client.send_request(method, path, {
+        :params  => params,
+        :headers => headers
+      })
+      result
+    end
+  end
+end

data/lib/yammer/configurable.rb

@@ -0,0 +1,81 @@
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+# 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 
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
+# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
+# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
+# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
+
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+require 'yammer/http_adapter'
+
+module Yammer
+  module Configurable
+
+    ENDPOINT = 'https://www.yammer.com' unless defined? ENDPOINT
+    HTTP_ADAPTER = Yammer::HttpAdapter unless defined? HTTP_CONNECTION
+
+    attr_accessor :client_id, :client_secret, :access_token, :site_url,
+    :connection_options, :default_headers, :http_adapter
+
+    # Return a hash with the default options
+    # @return [Hash]
+    def self.default_options
+      {
+        :site_url           => ENDPOINT,
+        :client_id          => ENV['YAMMER_CLIENT_ID'],
+        :client_secret      => ENV['YAMMER_CLIENT_SECRET'],
+        :access_token       => ENV['YAMMER_ACCESS_TOKEN'],
+        :http_adapter       => HTTP_ADAPTER,
+        :connection_options => { :max_redirects => 5, :verify_ssl => true },
+        :default_headers    => {
+          'Accept'     => 'application/json',
+          'User-Agent' => "Yammer Ruby Gem #{Yammer::Version}"
+        }
+      }
+    end
+
+    # @return [Array<String>]
+    def self.keys
+      self.default_options.keys
+    end
+
+    # @return [Hash]
+    def options
+      Hash[Yammer::Configurable.keys.map{|key| [key, instance_variable_get(:"@#{key}")]}]
+    end
+
+    def reset!
+      Yammer::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", Yammer::Configurable.default_options[key.to_sym])
+      end
+      self
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self if block_given?
+      self
+    end
+
+    def enable_logging(output='stdout')
+      self.http_adapter.log = output
+    end
+
+    def disable_logging
+      self.http_adapter.log = nil
+    end
+
+    def with_logging(output)
+      cached_output = self.http_adapter.log
+      enable_logging(output)
+      yield self if block_given?
+      self.http_adapter.log = cached_output
+    end
+  end
+end