yammer_api 0.1.0

data/lib/yammer_api/client.rb

@@ -0,0 +1,31 @@
+module YammerApi
+  class Client
+    include Api::Feed
+    include Api::Messages
+    include Api::Likes
+    include Api::Users
+    include Request
+
+    def initialize(options={})
+      @consumer_key     = options[:consumer_key]
+      @consumer_secret  = options[:consumer_key]
+      @auth_token       = options[:oauth_token]
+      @consumer_options = options[:oauth_options] || {}
+    end
+
+    def consumer
+      @consumer ||= ::OAuth2::Client.new(@consumer_key, @consumer_secret, @consumer_options.merge(DEFAULT_OAUTH_OPTIONS))
+    end
+
+    def access_token
+      @access_token ||= ::OAuth2::AccessToken.new(consumer, @auth_token)
+    end
+
+    protected
+      DEFAULT_OAUTH_OPTIONS = {
+          :site => 'https://www.yammer.com',
+          :authorize_url => '/dialog/oauth',
+          :token_url => '/oauth2/access_token.json'
+      }
+  end
+end

data/lib/yammer_api/errors.rb

@@ -0,0 +1,35 @@
+module YammerApi
+  module Errors
+    class Error < StandardError
+      attr_reader :data
+      def initialize(data)
+        @data = data
+        super
+      end
+    end
+
+    # Raised when Yammer returns the HTTP status code 400
+    class BadRequest < Error; end
+
+    # Raised when Yammer returns the HTTP status code 401
+    class Unauthorized < Error; end
+
+    # Raised when Yammer returns the HTTP status code 403
+    class Forbidden < Error; end
+
+    # Raised when Yammer returns the HTTP status code 404
+    class NotFound < Error; end
+
+    # Raised when Yammer returns the HTTP status code 406
+    class NotAcceptable < Error; end
+
+    # Raised when Yammer returns the HTTP status code 500
+    class InternalServerError < Error; end
+
+    # Raised when Yammer returns the HTTP status code 502
+    class BadGateway < Error; end
+
+    # Raised when Yammer returns the HTTP status code 503
+    class ServiceUnavailable < Error; end
+  end
+end

data/lib/yammer_api/helper.rb

@@ -0,0 +1,10 @@
+module YammerApi
+  module Helper
+    def params options
+      params_str = ""
+      params = options[:params] || {}
+      params.each { |key, value| params_str << "#{key}=#{value}&"}
+      ("?" + params_str.chop) unless (params_str == "")
+    end
+  end
+end

data/lib/yammer_api/mash.rb

@@ -0,0 +1,13 @@
+require 'hashie'
+require 'multi_json'
+
+module YammerApi
+  class Mash < ::Hashie::Mash
+
+    def self.from_json(json_string)
+      result_hash = MultiJson.decode(json_string || "{}")
+      new(result_hash)
+    end
+
+  end
+end

data/lib/yammer_api/post.rb

@@ -0,0 +1,39 @@
+module YammerApi
+  class Post < YammerApi::Base
+    lazy_attr_reader :attachment, :client_url, :id, :message_type, :network_id,
+                     :posted_at, :recipient, :replied_to_id, :sender_id, :text, :web_url
+
+    # @return Hashie::Mash
+    def attachment
+      attachment = @attrs['attachments'].first
+      if attachment
+        if attachment['type'] == "image"
+          @attachment ||= Mash.new(type: "image", id: attachment["id"], image_url: attachment.fetch("image", {"url" => ""}).fetch("url"))
+        else
+          @attachment ||= Mash.new(type: attachment['type'], name: attachment['name'], id: attachment["id"], image_url: attachment["large_icon_url"], url: attachment["download_url"])
+        end
+      end
+    end
+
+    # @return Time
+    def posted_at
+      #puts @attrs['created_at']
+      @posted_at ||= Time.parse(@attrs['created_at']).utc unless @attrs['created_at'].nil?
+    end
+
+    # @return String
+    def text
+      @text ||= @attrs['body']['plain'] if @attrs['body'] && @attrs['body']['plain']
+    end
+
+    # @return YammerApi::User
+    def user
+      @user ||= YammerApi::User.new(@attrs['sender']) if @attrs['sender']
+    end
+
+    # @return YammerApi::User
+    def recipient
+      @recipient ||= YammerApi::User.new(@attrs['recipient']) if @attrs['recipient']
+    end
+  end
+end

data/lib/yammer_api/request/request.rb

@@ -0,0 +1,83 @@
+require 'json'
+
+module YammerApi
+
+  module Request
+
+
+    DEFAULT_HEADERS = {
+        :headers => {"Content-Type" => "application/json"}
+    }
+
+    API_PATH = '/api/v1'
+
+    protected
+
+      def get(path, options={})
+        response = access_token.get("#{API_PATH}#{path}", DEFAULT_HEADERS.merge(options))
+        raise_errors(response)
+        Mash.from_json(response.body)
+      end
+
+      def post(path, body, options={})
+        response = access_token.post("#{API_PATH}#{path}", DEFAULT_HEADERS.merge(options).merge({:body => body}))
+        raise_errors(response)
+        Mash.from_json(response.body) if response.body
+      end
+
+      def put(path, options={})
+        response = access_token.put("#{API_PATH}#{path}", DEFAULT_HEADERS.merge(options))
+        raise_errors(response)
+        response.body
+      end
+
+      def delete(path, options={})
+        response = access_token.delete("#{API_PATH}#{path}", DEFAULT_HEADERS.merge(options))
+        raise_errors(response)
+        response
+      end
+
+    private
+
+      def raise_errors(response)
+        OAuth2::Response
+        case response.status.to_i
+          when 400
+            raise YammerApi::Errors::BadRequest.new("(#{response.code}): #{response.message}")
+          when 401
+            raise YammerApi::Errors::Unauthorized.new("(#{response.code}): #{response.message}")
+          when 403
+            raise YammerApi::Errors::Forbidden.new("(#{response.code}): #{response.message}")
+          when 404
+            raise YammerApi::Errors::NotFound.new("(#{response.code}): #{response.message}")
+          when 406
+            raise YammerApi::Errors::NotAcceptable.new("(#{response.code}): #{response.message}")
+          when 500
+            raise YammerApi::Errors::InternalServerError.new("(#{response.code}): #{response.message}")
+          when 502
+            raise YammerApi::Errors::BadGateway.new("(#{response.code}): #{response.message}")
+          when 503
+            raise YammerApi::Errors::ServiceUnavailable.new("(#{response.code}): #{response.message}")
+        end
+      end
+
+      def to_query(options)
+        options.inject([]) do |collection, opt|
+          collection << "#{opt[0]}=#{opt[1]}"
+          collection
+        end * '&'
+      end
+
+      def to_uri(path, options)
+        uri = URI.parse(path)
+
+        if options && options != {}
+          uri.query = to_query(options)
+        end
+        uri.to_s
+      end
+
+  end
+
+end
+

data/lib/yammer_api/user.rb

@@ -0,0 +1,24 @@
+module YammerApi
+  class User < YammerApi::Base
+
+    lazy_attr_reader :full_name, :id, :job_title, :nickname,
+                     :profile_url, :profile_image, :stats
+
+
+    # @return String
+    def nickname
+      @nickname ||= @attrs["name"] if @attrs["name"]
+    end
+
+    # @return String
+    def profile_url
+      @profile_url ||= @attrs["web_url"] if @attrs["web_url"]
+    end
+
+    # @return String
+    def profile_image
+      @profile_image ||= @attrs["mugshot_url"] if @attrs["mugshot_url"]
+    end
+
+  end
+end

data/lib/yammer_api/version.rb

@@ -0,0 +1,3 @@
+module YammerApi
+  VERSION = "0.1.0"
+end

data/spec/cases/client_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe YammerApi::Client do
+  before do
+    client.stub(:consumer).and_return(consumer)
+  end
+
+  let(:client) {YammerApi::Client.new(:consumer_key => "consumer_key", :consumer_secret => "consumer_secret", :oauth_token => "oauth_token")}
+  let(:consumer){OAuth2::Client.new('token', 'secret', {:site => 'https://yammer.com'})}
+
+  describe "User's network feed" do
+
+    it "client should get users feed" do
+      stub_http_request(:get, /https:\/\/yammer.com\/api\/v1\/messages.*/).
+          to_return(:body => "{}")
+      posts = client.messages
+      posts.length.should == 0
+      posts.should be_an_instance_of(Array)
+    end
+
+    it "returned array should contain posts" do
+      stub_http_request(:get, /https:\/\/yammer.com\/api\/v1\/messages.*/).
+          to_return(:body => fixture("network_feed.json"))
+
+      posts = client.messages
+
+      posts.length.should == 18
+      posts.first.should be_an_instance_of(YammerApi::Post)
+    end
+
+  end
+
+  describe "User's private messages" do
+
+
+    it "returned array should contain posts" do
+      stub_http_request(:get, /https:\/\/yammer.com\/api\/v1\/messages\/private.*/).
+          to_return(:body => fixture("private.json"))
+
+      posts = client.direct_messages
+
+      posts.length.should == 1
+      posts.first.should be_an_instance_of(YammerApi::Post)
+
+    end
+  end
+
+  describe "Posting messages" do
+    it "should be possible to post message" do
+      stub_http_request(:post, /https:\/\/yammer.com\/api\/v1\/messages.*/).
+          to_return(:body => fixture("newly_posted.json"))
+
+      post = client.update("OHAI")
+      post.should be_an_instance_of(YammerApi::Post)
+    end
+
+    it "should be possible to post direct message" do
+      stub_http_request(:post, /https:\/\/yammer.com\/api\/v1\/messages.*/).
+          to_return(:body => fixture("newly_posted.json"))
+
+      post = client.send_direct_message("OHAI", "123")
+      post.should be_an_instance_of(YammerApi::Post)
+    end
+  end
+
+end

data/spec/cases/post_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe YammerApi::Post do
+  before do
+    @fixture = MultiJson.decode(fixture "single_post.json")
+    @post = YammerApi::Post.new(@fixture)
+  end
+
+  it "should contain correct posting date" do
+    @post.posted_at.should == Time.parse(@fixture["created_at"]).utc
+  end
+
+  it "should contain correct text" do
+    @post.text.should == @fixture["body"]["plain"]
+  end
+
+  it "should have attachment" do
+    @post.attachment.should be_an_instance_of(YammerApi::Mash)
+    @post.attachment.type.should == "image"
+  end
+
+  it "should have sender" do
+    @post.user.should be_an_instance_of(YammerApi::User)
+  end
+
+end

data/spec/cases/user_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe YammerApi::User do
+  before do
+    @fixture = MultiJson.decode(fixture "single_user.json")
+    @user = YammerApi::User.new(@fixture)
+  end
+
+  it "should contain correct user id" do
+    @user.id.should == @fixture["id"]
+  end
+
+  it "should contain correct user name" do
+    @user.full_name.should == @fixture["full_name"]
+  end
+
+  it "should contain correct user nickname" do
+    @user.nickname.should == @fixture["name"]
+  end
+
+  it "should contain correct user profile image" do
+    @user.profile_image.should == @fixture["mugshot_url"]
+  end
+
+  it "should contain correct user profile url" do
+    @user.profile_url.should == @fixture["web_url"]
+  end
+
+
+end

data/spec/cases/yammer_api_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe YammerApi do
+  describe "Creating YammerApi instance" do
+
+    it "should delegate to YammerApi::Client" do
+      @yammer = YammerApi.new
+      @yammer.should be_an_instance_of(YammerApi::Client)
+    end
+
+
+  end
+
+end

data/spec/fixtures/about_topic.json

@@ -0,0 +1,103 @@
+{
+  "messages": [
+    {
+      "message_type": "update",
+      "liked_by": {
+        "count": 0,
+        "names": []
+      },
+      "created_at": "2011/02/12 02:41:14 +0000",
+      "thread_id": 78654647,
+      "url": "https://www.yammer.com/api/v1/messages/78654647",
+      "network_id": 104604,
+      "body": {
+        "plain": "Here's a message with a Topic Application.",
+        "parsed": "Here's a message with a Topic Application."
+      },
+      "privacy": "public",
+      "client_url": "https://www.yammer.com/",
+      "sender_type": "user",
+      "id": 78654647,
+      "system_message": false,
+      "attachments": [],
+      "sender_id": 1452329,
+      "replied_to_id": null,
+      "client_type": "Web",
+      "direct_message": false,
+      "web_url": "https://www.yammer.com/yammerdeveloperstestcommunity/messages/78654647"
+    }
+  ],
+  "threaded_extended": {},
+  "meta": {
+    "bookmarked_message_ids": [
+      78654647
+    ],
+    "current_user_id": 4022984,
+    "feed_name": "Interesting",
+    "followed_user_ids": [
+      1452329
+    ],
+    "show_billing_banner": false,
+    "requested_poll_interval": 60,
+    "feed_desc": "Messages in topic Interesting",
+    "ymodules": [],
+    "favorite_message_ids": [
+      78654647
+    ],
+    "realtime": {
+      "channel_id": "phxfy",
+      "authentication_token": "sev3eD8glyU+WgtixBMeFtJCcQec7HtgG+lgZW37Tvp4nKtWKi1OLVKyMjEwMrK0MNFRykstKc8vylayMjQwMTMACqRWFGQWVQL5xgaGxiaWBpYWtQCdvw7X",
+      "uri": "https://85.rt.yammer.com/cometd/"
+    }
+  },
+  "references": [
+    {
+      "type": "user",
+      "stats": {
+        "updates": 4,
+        "following": 2,
+        "followers": 1
+      },
+      "url": "https://www.yammer.com/api/v1/users/1452329",
+      "mugshot_url": "https://assets1.yammer.com/user_uploaded/photos/p1/0141/2640/n1644278019_46479_62_small.jpg",
+      "full_name": "Matt Knopp",
+      "job_title": null,
+      "state": "active",
+      "name": "mknopp",
+      "web_url": "https://www.yammer.com/yammerdeveloperstestcommunity/users/mknopp",
+      "id": 1452329
+    },
+    {
+      "type": "thread",
+      "topics": [
+        {
+          "type": "topic",
+          "id": 712836
+        }
+      ],
+      "thread_starter_id": 78654647,
+      "has_attachments": false,
+      "stats": {
+        "first_reply_at": null,
+        "latest_reply_at": "2011/02/12 02:41:14 +0000",
+        "updates": 1,
+        "latest_reply_id": 78654647,
+        "first_reply_id": null
+      },
+      "url": "https://www.yammer.com/api/v1/messages/in_thread/78654647",
+      "privacy": "public",
+      "direct_message": false,
+      "web_url": "https://www.yammer.com/yammerdeveloperstestcommunity#/Threads/show?threadId=78654647",
+      "id": 78654647
+    },
+    {
+      "type": "topic",
+      "url": "https://www.yammer.com/api/v1/topics/712836",
+      "normalized_name": "interesting",
+      "name": "Interesting",
+      "permalink": "interesting",
+      "web_url": "https://www.yammer.com/yammerdeveloperstestcommunity/topics/712836",
+      "id": 712836
+    }
+  ]
+}