yam 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfcfc553032f8390dc3e9152712c014c2e2121e3
-  data.tar.gz: 542b4d2bc6af453b05f4be934e4cb30616562354
+  metadata.gz: 2374b08700b4fa2d18344496c086d0b8480107da
+  data.tar.gz: 6720b27fa642e2697352f125ee27a9005cae2a9f
 SHA512:
-  metadata.gz: c067db8b3bb4ccd6b0841826218620127c5b806771589dc446415960be20cc999cfee10c51750653cda64034fd70a527394eb111ae0103629bbf01c0d76421f0
-  data.tar.gz: 450d9ec398c7f513cdd1d8b612f63ee06ac6327a1dafd2d4efb239b5c0dcf16489f7d064224d4c741c3b0aefe0a95897c5caf11e03a485bb1e28c43e0b0e6ac2
+  metadata.gz: a6f739f3511bcc24e9254a444ddc5ee27b35c08dfd1029e34565664a36a7004e390bfe37bf6a13cf3a064fffe2f3c4291985c9c5ca2504bc2082c276bf85e0d9
+  data.tar.gz: bc52ae55b4c8fbec4b6652fee1287c3826e9123bb00ffe46e93d106f0b6187d15eb5c7f1e3864804d3388a1041ab45621ab7236d2cb8fad58f83a1cb93046b5c

data/.travis.yml

@@ -3,8 +3,7 @@ rvm:
   - 2.0.0
   - 1.9.3
   - 1.9.2
-  - 1.8.7
-  - ree
+
 branches:
   only:
     - master

data/CHANGELOG.md

@@ -1,7 +1,13 @@
+1.1.0
+====================================
+- added support for activity api
+- added support for liking and unliking messages
+- small improvements to documentation
+
 1.0.0
 ====================================
 - Customized fork of yammer-client (https://github.com/tiabas/yammer-client)
 
 0.0.6
 ====================================
-- Alpha
+- Alpha

data/README.md

@@ -239,8 +239,8 @@ The object model is an abstraction that makes it easy to manipulate the JSON dat
 
 
     ```ruby
-    u = Yammer::User.current
-    #> <Yammer::User:0x007f9f4b0c39c8>
+    u = Yammer::Resources::User.current
+    #> <Yammer::Resources::User:0x007f9f4b0c39c8>
 
     u.full_name
     #> 'Kevin Mutyaba'
@@ -254,7 +254,7 @@ The object model is an abstraction that makes it easy to manipulate the JSON dat
     - *fetch a thread with a given id*
 
     ```ruby
-    t = Yammer::Thread.get(3)
+    t = Yammer::Resources::Thread.get(3)
     ```
 
     View the participants in the thread
@@ -268,27 +268,26 @@ The object model is an abstraction that makes it easy to manipulate the JSON dat
 
     ```ruby
     peepl = t.people
-    #> [#<Yammer::User:0x007f9f4c086630 @modified_attributes={}, @attrs={}, @new_record=false, @id=18>, #<Yammer::User:0x007f9f4c086568 @modified_attributes={}, @attrs={}, @new_record=false, @id=64>] 
+    #> [#<Yammer::Resources::User:0x007f9f4c086630 @modified_attributes={}, @attrs={}, @new_record=false, @id=18>, #<Yammer::Resources::User:0x007f9f4c086568 @modified_attributes={}, @attrs={}, @new_record=false, @id=64>] 
     ```
 
     Object models are lazyly loaded. Calling an accessor on a model will hydrate it
 
     ```ruby
     peepl[0]
-    #> #<Yammer::User:0x007f9f4c086568 @modified_attributes={}, @attrs={}, @new_record=false, @id=18> 
+    #> #<Yammer::Resources::User:0x007f9f4c086568 @modified_attributes={}, @attrs={}, @new_record=false, @id=18> 
 
     peepl[0].permalink
     #> 'thekev'
 
     peepl[0]
-    #=> #<Yammer::User:0x007f9f4c086568 @modified_attributes={}, @attrs={:last_name=>"Mutyaba", :network_id=>1, :first_name=>"Kevin", :id => 18,  :permalink=>"thekev" }, @network_id=1, @first_name="Kev", @full_name="Tiaba", @permalink="thekev", @id=18 > 
+    #=> #<Yammer::Resources::User:0x007f9f4c086568 @modified_attributes={}, @attrs={:last_name=>"Mutyaba", :network_id=>1, :first_name=>"Kevin", :id => 18,  :permalink=>"thekev" }, @network_id=1, @first_name="Kev", @full_name="Tiaba", @permalink="thekev", @id=18 > 
     ```
 
 ## Supported Ruby Versions
 This library aims to support and is [tested against][travis] the following Ruby
 version:
 
-* Ruby 1.8.7
 * Ruby 1.9.2
 * Ruby 1.9.3
 * Ruby 2.0.0

data/lib/yammer/http_adapter.rb

@@ -17,84 +17,84 @@ require 'multi_json'
 require 'addressable/uri'
 
 module Yammer
-  class HttpAdapter
+class HttpAdapter
 
-    def self.log=(output)
-      RestClient.log = output
-    end
+  def self.log=(output)
+    RestClient.log = output
+  end
 
-    attr_reader :site_url, :connection_options
+  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
+  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
+  # 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 host
+    @host ||= parsed_url.host
+  end
 
-    def scheme
-      @scheme ||= parsed_url.scheme
-    end
+  def scheme
+    @scheme ||= parsed_url.scheme
+  end
 
-    def absolute_url(path='')
-      "#{@site_url}#{path}"
-    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 connection_options=(opts)
+    raise ArgumentError, 'expected Hash' unless opts.is_a?(Hash)
+    @connection_options = opts
+  end
 
-    def send_request(method, path, opts={})
-      begin
-        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)
-      rescue => e
-        if e.is_a?(RestClient::ExceptionWithResponse)
-          e.response
-        else
-          raise e
-        end
+  def send_request(method, path, opts={})
+    begin
+      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
-    end
 
-  private
-    def parsed_url
-      Addressable::URI.parse(@site_url)
+      resp = RestClient::Request.execute(req_opts)
+    
+      result = Yammer::ApiResponse.new(resp.headers, resp.body, resp.code)
+    rescue => e
+      if e.is_a?(RestClient::ExceptionWithResponse)
+        e.response
+      else
+        raise e
+      end
     end
+  end
 
+private
+  def parsed_url
+    Addressable::URI.parse(@site_url)
   end
+
+end
 end

data/lib/yammer/resources/base.rb

@@ -0,0 +1,210 @@
+# 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 Resources
+    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::Resources::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
+end

data/lib/yammer/{group.rb → resources/group.rb}

@@ -13,15 +13,17 @@
 # permissions and limitations under the License.
 
 module Yammer
-  class Group < Yammer::Base
+  module Resources
+    class Group < Yammer::Resources::Base
 
-    attr_accessor_deffered :show_in_directory, :privacy, :description, :creator_type,
-    :creator_id, :mugshot_id, :stats, :state, :web_url, :name, :created_at, :type,
-    :mugshot_url, :url, :full_name, :mugshot_url_template, :description
+      attr_accessor_deffered :show_in_directory, :privacy, :description, :creator_type,
+      :creator_id, :mugshot_id, :stats, :state, :web_url, :name, :created_at, :type,
+      :mugshot_url, :url, :full_name, :mugshot_url_template, :description
 
-    # @!scope class
-    def self.create(params={})
-      api_handler.create_group(params)
+      # @!scope class
+      def self.create(params={})
+        api_handler.create_group(params)
+      end
     end
   end
 end

data/lib/yammer/{group_membership.rb → resources/group_membership.rb}

@@ -13,13 +13,15 @@
 # permissions and limitations under the License.
 
 module Yammer
-  class GroupMembership < Yammer::Base
+  module Resources
+    class GroupMembership < Yammer::Resources::Base
 
-    attr_accessor_deffered 
+      attr_accessor_deffered 
 
-    # @!scope class
-    def self.create(id)
-      api_handler.create_group_membership(id)
+      # @!scope class
+      def self.create(id)
+        api_handler.create_group_membership(id)
+      end
     end
   end
 end

data/lib/yammer/resources/identity_map.rb

@@ -0,0 +1,58 @@
+# 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 Resources
+    class IdentityMap
+
+      class InvalidKeyError < StandardError; end
+
+      def initialize
+        @map  = {}
+        @size = 0
+      end
+
+      # @note retrives key from identity map
+      # @return [Hash]
+      # @param key [string] 
+      # @param default [Hash]
+      def get(key, default=nil)
+        @map["#{key}"] || default
+      end
+
+      # @note inserts a hash of attributes into identity map
+      # @return [Hash]
+      # @param key [string] 
+      # @param value [Hash]
+      def put(key, value)
+        if key.nil? || key.empty?
+          raise InvalidKeyError.new
+        end
+        @map["#{key}"] = value
+      end
+
+      # @note returns the current size of identity map
+      # @return [Integer]
+      def size
+        @map.keys.count
+      end
+
+      # clears the entire identity map
+      # @return [Hash]
+      def purge!
+        @map = {}
+      end
+    end
+  end
+end

data/lib/yammer/resources/message.rb

@@ -0,0 +1,34 @@
+# 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 Resources
+    class Message < Yammer::Resources::Base
+
+      attr_accessor_deffered :direct_message, :privacy, :group_id, :created_at,
+      :attachments, :liked_by, :chat_client_sequence, :client_url, :content_excerpt,
+      :message_type, :url, :web_url, :network_id, :system_message, :client_type, 
+      :sender_type, :sender_id, :thread_id, :conversation_id, :replied_to_id, :body
+
+      attr_reader :replied_to_id
+
+      # Creates a new message
+      # @!scope class
+      def self.create(body, params={})
+        api_handler.create_message(body, params)
+      end
+
+    end
+  end
+end

data/lib/yammer/{message.rb → resources/message_body.rb}

@@ -13,20 +13,17 @@
 # permissions and limitations under the License.
 
 module Yammer
-  class Message < Yammer::Base
+  module Models
+    class MessageBody
+      attr_reader :urls, :parsed, :rich
+      attr_accessor :plain
 
-    attr_accessor_deffered :direct_message, :privacy, :group_id, :created_at,
-    :attachments, :liked_by, :chat_client_sequence, :client_url, :content_excerpt,
-    :message_type, :url, :web_url, :network_id, :system_message, :client_type, 
-    :sender_type, :sender_id, :thread_id, :conversation_id, :replied_to_id, :body
-
-    attr_reader :replied_to_id
-
-    # Creates a new message
-    # @!scope class
-    def self.create(body, params={})
-      api_handler.create_message(body, params)
+      def initialize(opts={})
+        @plain  = opts.fetch(:plain,'')
+        @parsed = opts.fetch(:parsed,'')
+        @rich   = opts.fetch(:rich,'')
+        @urls   = opts.fetch(:urls,'')
+      end
     end
-
   end
 end

data/lib/yammer/resources/thread.rb

@@ -0,0 +1,60 @@
+# 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 Resources
+    class Thread < Yammer::Resources::Base
+
+      attr_accessor_deffered :participants, :web_url, :references, :thread_starter_id,
+      :type, :privacy, :has_attachments, :attachments_meta, :topics, :url, :attachments,
+      :direct_message, :participants_count, :stats
+
+      def first_reply_id
+        stats[:first_reply_id]
+      end
+
+      def first_reply
+        @first_reply ||= first_reply_id ? Yammer::Resources::Message.new(:id => first_reply_id) : nil
+      end
+
+      def latest_reply_id
+        stats[:latest_reply_id]
+      end
+
+      def last_reply
+        @latest_reply ||= latest_reply_id ? Yammer::Resources::Message.new(:id => latest_reply_id) : nil
+      end
+
+      def people
+        @people ||= begin
+          @participants.map do |part|
+            next unless part[:type] == 'user'
+            Yammer::Resources::User.new(:id => part[:id])
+          end
+        end
+        @people
+      end
+
+      def messages
+        @messages = {}
+        result = api_handler.messages_in_thread(self.id)
+        msgs = result.body[:messages].each do |message|
+          msg = Yammer::Resources::Message.new(message)
+          @messages["#{msg.id}"] = msg
+        end
+        @messages
+      end
+    end
+  end
+end