yam 0.0.6 → 1.0.0

data/lib/yammer/error.rb

@@ -0,0 +1,75 @@
+# 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 Error
+
+    class << self
+      def from_status(status=nil)
+        case status
+        when 400
+          BadRequest
+        when 401
+          Unauthorized
+        when 403
+          Forbidden
+        when 404
+          NotFound
+        when 406
+          NotAcceptable
+        when 429
+          RateLimitExceeded
+        when 500
+          InternalServerError
+        when 502
+          BadGateway
+        when 503
+          ServiceUnavailable
+        else
+          ApiError
+        end
+      end
+    end
+
+    # Raised when Yammer returns unknown HTTP status code
+    class ApiError < StandardError;  end
+
+    # Raised when Yammer returns the HTTP status code 400
+    class BadRequest < ApiError; end
+
+    # Raised when Yammer returns the HTTP status code 401
+    class Unauthorized < ApiError; end
+
+    # Raised when Yammer returns the HTTP status code 403
+    class Forbidden < ApiError; end
+
+    # Raised when Yammer returns the HTTP status code 404
+    class NotFound < ApiError; end
+
+    # Raised when Yammer returns the HTTP status code 406
+    class NotAcceptable < ApiError; end
+
+    # Raised when Yammer returns the HTTP status code 429
+    class RateLimitExceeded < ApiError; end
+
+    # Raised when Yammer returns the HTTP status code 500
+    class InternalServerError < ApiError; end
+
+    # Raised when Yammer returns the HTTP status code 502
+    class BadGateway < ApiError; end
+
+    # Raised when Yammer returns the HTTP status code 503
+    class ServiceUnavailable < ApiError; end
+  end
+end

data/lib/yammer/group.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
+  class Group < Yammer::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
+
+    # @!scope class
+    def self.create(params={})
+      result = api_handler.create_group(params)
+    end
+  end
+end

data/lib/yammer/group_membership.rb

@@ -0,0 +1,25 @@
+# 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 GroupMembership < Yammer::Base
+
+    attr_accessor_deffered 
+
+    # @!scope class
+    def self.create(id)
+      api_handler.create_group_membership(id)
+    end
+  end
+end

data/lib/yammer/http_adapter.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 'restclient'
+require 'multi_json'
+require 'addressable/uri'
+
+module Yammer
+  class HttpAdapter
+
+    def self.log=(output)
+      RestClient.log = output
+    end
+
+    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={})
+      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
+      end
+    end
+
+  private
+    def parsed_url
+      Addressable::URI.parse(@site_url)
+    end
+
+  end
+end

data/lib/yammer/identity_map.rb

@@ -0,0 +1,56 @@
+# 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 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

data/lib/yammer/message.rb

@@ -0,0 +1,32 @@
+# 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 Message < Yammer::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

data/lib/yammer/message_body.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
+  class MessageBody
+    attr_reader :urls, :parsed, :rich
+    attr_accessor :plain
+
+    def initialize(opts={})
+      @plain  = opts.fetch(:plain,'')
+      @parsed = opts.fetch(:parsed,'')
+      @rich   = opts.fetch(:rich,'')
+      @urls   = opts.fetch(:urls,'')
+    end
+  end
+end

data/lib/yammer/pending_attachment.rb

@@ -0,0 +1,19 @@
+# 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 PendingAttachment
+
+  end
+end

data/lib/yammer/thread.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
+  class Thread < Yammer::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::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::Message.new(:id => latest_reply_id) : nil
+    end
+
+    def people
+      @people ||= begin
+        @participants.map do |part|
+          next unless part[:type] == 'user'
+          Yammer::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::Message.new(message)
+        @messages["#{msg.id}"] = msg
+      end
+      @messages
+    end
+  end
+end

data/lib/yammer/user.rb

@@ -0,0 +1,66 @@
+# 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 User < Yammer::Base
+
+
+    # Returns authenticated user's details
+    # @!scope class
+    def self.current
+      result = api_handler.current_user
+      return nil unless result.success?
+      new(result.body)
+    end
+
+    # Creates a new user from email address
+    # @!scope class
+    def self.create(email)
+      result = api_handler.create_user(:email => email)
+      return nil unless result.created?
+      id = result.headers[:location].split('/').last.to_i
+      new(:id => id)
+    end
+
+    attr_accessor_deffered :first_name, :last_name, :full_name, :hire_date, :mugshot, :state,
+    :type, :admin, :verified_admin, :expertise, :birth_date, :stats, :show_ask_for_photo, :job_title,
+    :web_url, :url, :external_urls, :activated_at, :summary, :department, :previous_companies,
+    :follow_general_messages, :schools, :interests, :significant_other, :network_name, :network_id,
+    :can_broadcast, :web_preferences, :network_domains, :location, :contact, :kids_names, :guid,
+    :name, :mugshot_url, :mugshot_url_template, :settings, :timezone
+
+    # Returns user's primary email
+    def email
+      @email ||= begin
+        self.contact[:email_addresses].map do |e|
+          e[:address] if e[:type] == 'primary'
+        end.first
+      end
+    end
+
+    # Returns all users that this user is following
+    def following
+      api_handler.users_followed_by(@id)
+    end
+
+    # Returns all user's follwing this user
+    def followers
+      api_handler.users_following(@id)
+    end
+
+    # Updates the user attributes
+    def update!(params)
+      api_handler.update_user(@id, params)
+    end
+  end
+end