yammer_api 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yammer_api.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Magdalena Sikorska
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# YammerApi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yammer_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yammer_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/yammer_api.rb

@@ -0,0 +1,33 @@
+require 'omniauth-oauth2'
+
+module YammerApi
+  autoload :Api,     "yammer_api/api"
+  autoload :Base,    "yammer_api/base"
+  autoload :Client,  "yammer_api/client"
+  autoload :Errors,  "yammer_api/errors"
+  autoload :Helper,  "yammer_api/helper"
+  autoload :Mash,    "yammer_api/mash"
+  autoload :Request, "yammer_api/request/request"
+  autoload :Post,    "yammer_api/post"
+  autoload :User,    "yammer_api/user"
+
+  class << self
+    #Alias for YammerApi::Client.new
+    #@return [YammerApi::Client]
+    def new(options={})
+      YammerApi::Client.new(options)
+    end
+
+    # Delegate to Yammer::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+
+
+end

data/lib/yammer_api/api.rb

@@ -0,0 +1,8 @@
+module YammerApi
+  module Api
+    autoload :Feed, 'yammer_api/api/feed'
+    autoload :Messages, 'yammer_api/api/messages'
+    autoload :Likes, 'yammer_api/api/likes'
+    autoload :Users, 'yammer_api/api/users'
+  end
+end

data/lib/yammer_api/api/feed.rb

@@ -0,0 +1,195 @@
+module YammerApi
+  module Api
+    module Feed
+
+      include Helper
+
+      # Returns the 20 most recent messages in this network. Corresponds to the "Company Feed" tab on the website.
+      #
+      # @note Developers should note that a strict rate limit is applied to all API requests, so clients should never poll for new messages more frequently than every 30 seconds to ensure that the user is still able to use the API for posting messages, etc.
+      # @format `:json`, `:xml`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Yammer::Post]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent messages in this network.
+      #   Yammer.messages
+      def messages(options={})
+        path = "/messages.json" + params(options).to_s
+        get_and_parse_posts path, options
+      end
+
+      # Returns the 20 sent messages by the current logged in user.
+      # Alias for `/api/v1/messages/from_user/logged-in_user_id.format`. Corresponds to the "Sent" tab on the website.
+      #
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Yammer::Post]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent sent messages
+      #   Yammer.messages_sent
+      def messages_sent(options={})
+        path = "/messages/sent.json" + params(options).to_s
+        get_and_parse_posts path, options
+      end
+
+      # Messages received by the logged-in user. Corresponds to the "Received" tab on the website.
+      #
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Yammer::Post]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent received messages
+      #   Yammer.messages_received
+      def messages_received(options={})
+        path = "/messages/received.json" + params(options).to_s
+        get_and_parse_posts path, options
+      end
+
+      # Private Messages (aka Direct Messages) for the logged-in user. Corresponds to the "Direct Messages" section on the website.
+      #
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Yammer::Post]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent private messages
+      #   Yammer.direct_messages
+      def direct_messages(options={})
+        path = "/messages/private.json" + params(options).to_s
+        get_and_parse_dms path, options
+      end
+
+      # Messages followed by the logged-in user. Corresponds to the "My Feed" tab on the website.
+      #
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Yammer::Post]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent received messages in my feed
+      #   Yammer.my_feed
+      def my_feed(options={})
+        #response = get('messages/following', options, :json)
+        path = "/messages/following.json" + params(options).to_s
+        get_and_parse_posts path, options
+      end
+
+      # Messages sent by the user with the given ID. Corresponds to the messages on a user profile page on the website.
+      #
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer, String] A user ID or screen name.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Yammer::Post]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent messages from the user
+      #   Yammer.messages_from("bruno")
+      def messages_from(id, options={})
+        path = "/messages/from_user/#{id}.json" + params(options).to_s
+        get_and_parse_posts path, options
+      end
+
+      # Messages that have the topic with given ID. Corresponds to the messages on a topic's page on the website.
+      #
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer] A topic ID
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Yammer::Post]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the messages in topic with ID 1234567
+      #   Yammer.about_topic(1234567)
+      def about_topic(id, options={})
+        path = "/messages/about_topic/#{id}.json" + params(options).to_s
+        get_and_parse_posts path, options
+      end
+
+      # Messages in the thread with the given ID. Corresponds to the page you'd see when clicking on "in reply to" on the website.
+      #
+      # @note Does not accept the threaded parameter.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer] A thread ID
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Yammer::Post]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the messages in the thread with ID 1234567
+      #   Yammer.thread(1234567)
+      def thread(id, options={})
+        path = "/messages/in_thread/#{id}.json" + params(options).to_s
+        get_and_parse_posts path, options
+      end
+
+      private
+        def get_and_parse_posts path, options
+          response = get(path, options)
+          raw_messages = response.fetch("messages", [])
+          raw_ref = response.fetch("references", [])
+          raw_messages.map{|post|
+            sender = raw_ref.find{|u| u.id == post.sender_id && u.type == "user"}
+            YammerApi::Post.new(post.merge(:sender => sender))
+          }
+        end
+
+        def get_and_parse_dms path, options
+          response = get(path, options)
+          raw_messages = response.fetch("messages", [])
+          raw_ref = response.fetch("references", [])
+          raw_messages.map{|post|
+            sender = raw_ref.find{|u| u.id == post.sender_id && u.type == "user"} || raw_ref.find{|u| u.id == post.sender_id && u.type == "guide"}
+            recipient = raw_ref.find{|u| u.id == post.direct_to_id && u.type == "user"}
+            YammerApi::Post.new(post.merge(:sender => sender, :recipient => recipient))
+          }
+        end
+
+    end
+  end
+end

data/lib/yammer_api/api/likes.rb

@@ -0,0 +1,33 @@
+module YammerApi
+  module Api
+    module Likes
+
+      include Helper
+
+      # Likes a specified message
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer] The ID of message.
+      # @see http://developer.yammer.com/api/#likes
+      def add_like(id, options={})
+        path = "/messages/liked_by/current.json"
+        post(path, {:message_id => id}.to_json)
+      end
+
+      # Unlikes a specified message
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer] The ID of message.
+      # @see http://developer.yammer.com/api/#likes
+      def remove_like(id, options={})
+        path = "/messages/liked_by/current.json?message_id=#{id}"
+        delete(path, options)
+      end
+
+    end
+  end
+end

data/lib/yammer_api/api/messages.rb

@@ -0,0 +1,65 @@
+module YammerApi
+  module Api
+    module Messages
+
+      include Helper
+      # Creates a new message from the authenticating user
+      #
+      # @note A status update with text identical to the authenticating user's current status will be ignored to prevent duplicates.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited false
+      # @param body [String] The text of your message.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :group_id The ID of the group in which this message belongs.
+      # @option options [Integer] :replied_to_id The message ID this message is in reply to, if applicable.
+      # @option options [Integer] :direct_to_id the ID of the user to which this message will be sent as a private message.
+      # @option options [String] :broadcast If `true` this message should be broadcasted to all users. *Must be an admin*
+      # @option options [Integer] :topic*n* Topics to apply to the message. Can use topic1 through topic20.
+      # @return [YammerApi::Post] The created message.
+      # @see http://developer.yammer.com/api/#messages-manipulating
+      def update(message, options={})
+        path = "/messages.json"
+        response = post(path, {:body => message}.merge(options).to_json)
+        parse_post(response)
+      end
+
+
+      # Creates a new direct message from the authenticating user to selected user
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited false
+      # @param body [String] The text of your message.
+      # @param user_id [String] The id of message recipient.
+      # @return [YammerApi::Post] The created message.
+      # @see http://developer.yammer.com/api/#messages-manipulating
+      def send_direct_message(message, user_id, options={})
+        path = "/messages.json"
+        response = post(path, {:body => message, :direct_to_id => user_id}.merge(options).to_json)
+        parse_post(response)
+      end
+
+      # Deletes a specified message from the authenticating user
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited false
+      # @param id [Integer] The ID of your message.
+      # @see http://developer.yammer.com/api/#messages-manipulating
+      def delete_message(id, options={})
+        path = "/messages/#{id}"
+        delete(path, options)
+      end
+
+      private
+        def parse_post response
+          raw_messages = response.fetch("messages", [])
+          raw_ref = response.fetch("references", [])
+          post = raw_messages.first
+          sender = raw_ref.find{|u| u.id == post.sender_id && u.type == "user" || u.type == "guide"}
+          YammerApi::Post.new(post.merge(:sender => sender))
+        end
+    end
+  end
+end

data/lib/yammer_api/api/users.rb

@@ -0,0 +1,22 @@
+module YammerApi
+  module Api
+    module Users
+
+      include Helper
+
+      # Get information about specified user
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer] The ID of user.
+      # @see http://developer.yammer.com/api/#users
+      def user(id, options={})
+        path = "/users/#{id}.json"
+        response = get(path, options)
+        YammerApi::User.new(response)
+      end
+
+    end
+  end
+end

data/lib/yammer_api/base.rb

@@ -0,0 +1,41 @@
+module YammerApi
+  class Base
+
+    attr_accessor :attrs
+    alias :to_hash :attrs
+
+    # Define methods that retrieve the value from an initialized instance variable Hash, using the attribute as a key
+    #
+    # @overload self.lazy_attr_reader(attr)
+    #   @param attr [Symbol]
+    # @overload self.lazy_attr_reader(attrs)
+    #   @param attrs [Array<Symbol>]
+    def self.lazy_attr_reader(*attrs)
+      attrs.each do |attribute|
+        class_eval do
+          define_method attribute do
+            @attrs[attribute.to_s]
+          end
+        end
+      end
+    end
+
+    # Initializes a new Base object
+    #
+    # @param attrs [Hash]
+    # @return [YammerApi::Base]
+    def initialize(attrs={})
+      @attrs = attrs.dup
+    end
+
+    # Initializes a new Base object
+    #
+    # @param method [String, Symbol] Message to send to the object
+    def [](method)
+      self.__send__(method.to_sym)
+    rescue NoMethodError
+      nil
+    end
+
+  end
+end