yam 0.0.6 → 1.0.0

data/lib/yammer/api/network.rb

@@ -0,0 +1,35 @@
+# 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 Api
+    module Network
+
+      # @see https://developer.yammer.com/restapi/#rest-network
+      # @api_path /api/v1//networks/current
+      # @rate_limited Yes
+      # @authentication authenticated user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Boolean] :include_suspended
+      # @option opts [Boolean] :exclude_own_messages_from_unseen
+      # @example Fetch all networks that the current user is a member of
+      #   Yammer.current_networks
+      def current_networks(opts={})
+        get('/api/v1/networks/current', opts)
+      end
+    end
+  end
+end

data/lib/yammer/api/notification.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
+  module Api
+    module Notification
+
+      # @see https://developer.yammer.com/restapi/#rest-notifications
+      # @api_path /api/v1/streams/notifications
+      # @rate_limited Yes
+      # @authentication authenticated user context
+      # @raise [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @example Fetch notifications for authenticated user
+      #   Yammer.notifications
+      def notifications
+        get('/api/v1/streams/notifications')
+      end
+    end
+  end
+end

data/lib/yammer/api/open_graph_object.rb

@@ -0,0 +1,92 @@
+# 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 Api
+    module OpenGraphObject
+
+      # @see https://developer.yammer.com/
+      # @api_path /api/v1/open_graph_objects/
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param [String] url The URL of the open graph object
+      # @param [Hash] props The properties of this open graph object
+      # @option props [String] :image
+      # @option props [String] :description
+      # @option props [String] :site_name
+      # @option props [String] :title
+      # @option props [String] :media_url
+      # @option props [String] :media_type
+      # @option props [String] :media_width
+      # @option props [String] :media_height
+      # @example Create a new open graph object
+      #
+      # Yammer.create_open_graph_object('http://www.microsoft.com', {
+      #  :site_name => 'Microsoft'
+      #  :image     => 'https://microsoft.com/global/images/test.jpg'
+      # })
+      def create_open_graph_object(url, props={})
+        post("/api/v1/open_graph_objects", { :url => url, :properites => props })
+      end
+
+      # Subscribes the current user to the open graph object with the request id.
+      # @see https://developer.yammer.com/
+      # @api_path /api/v1/open_graph_objects/
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param [Integer] id The ID of the open graph object
+      # @example Subscribe to open graph object
+      #
+      # => Yammer.follow_open_graph_object(8)
+      def follow_open_graph_object(id)
+        post('/api/v1/subscriptions', :target_id => id, :target_type => 'OpenGraphObject')
+      end
+
+      # Determines if the current user follows an open graph object
+      # @see https://developer.yammer.com/
+      # @api_path /api/v1/open_graph_objects/
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param [Integer] id The ID of the open graph object
+      # @example Verify to open graph object
+      #
+      # => Yammer.following_open_graph_object?(89)
+      def is_following_open_graph_object?(id)
+        get("/api/v1/subscriptions/to_open_graph_object/#{id}")
+      end
+
+
+      # Returns open graph objects in a user's activity stream
+      # @see https://developer.yammer.com/
+      # @api_path /api/v1/streams/activities
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param [Integer] id The ID of the users whose stream of open graph objects we want to fetch
+      # @example Get open graph object in a given user's activity stream
+      #
+      #  Yammer.get_activity_stream_open_graph_objects?(3)
+      def get_activity_stream_open_graph_objects(id)
+        get("/api/v1/streams/activities", :owner_type => 'open_graph_object', :owner_id => id)
+      end
+    end
+  end
+end

data/lib/yammer/api/pending_attachment.rb

@@ -0,0 +1,64 @@
+# 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 Api
+    module PendingAttachment
+
+      # Create a new pending attachment owned by authenticated user
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/pending_attachments
+      # @rate_limited Yes
+      # @authentication User context
+      # @raise [Yammer::Error::Unauthorized Yammer::Error::Forbidden] Error when supplied user credentials are not valid
+      #   when user network does not allow attachments
+      # @return [Yammer::ApiResponse]
+      # @example Fetch existing pending attachment
+      #   Yammer.get_pending_attachment(62)
+      def get_pending_attachment(id)
+        get("/api/v1/pending_attachments/#{id}")
+      end
+
+      # Delete a pending attachment owned by the authenticated user
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/pending_attachments
+      # @rate_limited Yes
+      # @authentication User context
+      # @raise [Yammer::Error::Unauthorized Yammer::Error::NotFound] Error raised when supplied user credentials are not valid
+      #   when attachment cannot be found
+      # @return [Yammer::ApiResponse]
+      # @example Delete existing pending attachment
+      #   Yammer.delete_pending_attachment(34)
+      def delete_pending_attachment(id)
+        delete("/api/v1/pending_attachments/#{id}")
+      end
+
+      # Fetch a pending attachment owned by authenticated user
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/pending_attachments
+      # @rate_limited Yes
+      # @authentication User context
+      # @raise [Yammer::Error::Unauthorized Yammer::Error::NotFound] Error raised when supplied user credentials are not valid
+      #   when attachment cannot be found
+      # @return [Yammer::ApiResponse]
+      # @example Create new pending attachment
+      #   file = File.open('~/attachment.txt', 'r')
+      #   Yammer.create_pending_attachment(file)
+      #
+      def create_pending_attachment(attachment)
+        post("/api/v1/pending_attachments", :attachment => attachment)
+      end
+    end
+  end
+end

data/lib/yammer/api/search.rb

@@ -0,0 +1,42 @@
+# 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 Api
+    module Search
+
+      # @see https://developer.yammer.com/restapi/#rest-search
+      # @api_path /api/v1/search
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :num_per_page
+      # @option opts [Integer] :page
+      # @option opts [Integer] :search_group
+      # @option opts [Integer] :search_user
+      # @option opts [String] :search_sort
+      # @option opts [String] :match
+      # @option opts [String] :model_types
+      # @option opts [String] :search_startdate
+      # @option opts [String] :search_enddate
+      # @example Search for a particular term on within current user's network
+      #   Yammer.search(:search => 'documents')
+      def search(opts={})
+        get('/api/v1/search', opts)
+      end
+    end
+  end
+end

data/lib/yammer/api/subscription.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
+  module Api
+    module Subscription
+
+      # @see https://developer.yammer.com/
+      # @api_path /api/v1/subscriptions/
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param [Integer] id
+      # @param [String]  type
+      def create_subscription(type, id)
+        post('/api/v1/subscriptions', :target_id => id, :target_type => type)
+      end
+    end
+  end
+end

data/lib/yammer/api/thread.rb

@@ -0,0 +1,37 @@
+# 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 Api
+    module Thread
+
+      # @see https://developer.yammer.com/restapi/#rest-threads
+      # @api_path /api/v1/threads/id
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param id [Integer] the thread ID
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :newer_than
+      # @option opts [String] :threaded
+      # @option opts [Boolean] :exclude_own_messages_from_unseen
+      # @example Fetch data for the thread
+      #   Yammer.get_thread(42)
+      def get_thread(id, opts={})
+        get("/api/v1/threads/#{id}", opts)
+      end
+    end
+  end 
+end

data/lib/yammer/api/topic.rb

@@ -0,0 +1,37 @@
+# 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 Api
+    module Topic
+
+      # @see https://developer.yammer.com/restapi/#rest-topics
+      # @api_path /api/v1/topics
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied
+      #   user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param id [Integer]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :is_followed_by include if specified user
+      #   is following topic that is being fetched
+      # @example Fetch data for the thread
+      #   Yammer.get_topic(42, :is_followed_by => 2)
+      def get_topic(id, opts={})
+        get("/api/v1/topics/#{id}", opts)
+      end
+    end
+  end 
+end

data/lib/yammer/api/user.rb

@@ -0,0 +1,168 @@
+# 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 Api
+    module User
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param  opts [Hash] A customizable set of options.
+      # @option opts [String] :email
+      # @option opts [String] :full_name
+      # @option opts [String] :guid 
+      # @option opts [String] :job_title
+      # @option opts [String] :location
+      # @option opts [String] :im_provider
+      # @option opts [String] :im_username
+      # @option opts [String] :work_telephone
+      # @option opts [String] :work_extension
+      # @option opts [String] :mobile_telephone
+      # @option opts [String] :external_profiles
+      # @option opts [String] :significant_other
+      # @option opts [String] :kids_names
+      # @option opts [String] :interests
+      # @option opts [String] :summary
+      # @option opts [String] :expertise
+      # @option opts [String] :schools_csv
+      # @option opts [String] :previous_companies_csv
+      # @option opts [String] :preferred_my_feed
+      # @option opts [String] :sticky_my_feed
+      # @option opts [String] :prescribed_my_feed
+      # @example create a user with the email `thekev@yammer.com`
+      #   Yammer.create_user('thekev@yammer.com')
+      def create_user(opts={})
+        post("/api/v1/users", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param  opts [Hash] A customizable set of options.
+      # @option opts [String] :email
+      # @option opts [String] :full_name
+      # @option opts [String] :guid 
+      # @option opts [String] :job_title
+      # @option opts [String] :location
+      # @option opts [String] :im_provider
+      # @option opts [String] :im_username
+      # @option opts [String] :work_telephone
+      # @option opts [String] :work_extension
+      # @option opts [String] :mobile_telephone
+      # @option opts [String] :external_profiles
+      # @option opts [String] :significant_other
+      # @option opts [String] :kids_names
+      # @option opts [String] :interests
+      # @option opts [String] :summary
+      # @option opts [String] :expertise
+      # @option opts [String] :schools_csv
+      # @option opts [String] :previous_companies_csv
+      # @option opts [String] :preferred_my_feed
+      # @option opts [String] :sticky_my_feed
+      # @option opts [String] :prescribed_my_feed
+      # @example update info for a user with the email `thekev@yammer.com`
+      #   Yammer.update_user(1, :job_title => 'software engineer')
+      def update_user(id, opts={})
+        put("/api/v1/users/#{id}", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param id [Integer, String] A Yammer user ID
+      # @example Delete user with ID 2
+      #   Yammer.delete_user(2)
+      def delete_user(id)
+        delete("/api/v1/users/#{id}")
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param id [Integer, String] A Yammer user ID
+      # @example Fetch data user with ID 2
+      #   Yammer.get_user(2)
+      def get_user(id)
+        get("/api/v1/users/#{id}")
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param email [Integer, String] A Yammer user ID
+      # @example Fetch data user with email `thekev@yammer.com`
+      #   Yammer.get_user_by_email('thekev@yammer.com')
+      def get_user_by_email(email)
+        get("/api/v1/users/by_email", :email => email)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @example Fetch data for the authenticated user
+      #   Yammer.current_user
+      def current_user
+        get("/api/v1/users/current")
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param  opts [Hash] A customizable set of opts.
+      # @option opts [Integer] :page
+      # @example Fetch users from the authenticated user's network
+      #   Yammer.all_users
+      def all_users(opts={})
+        get("/api/v1/users", opts)
+      end
+
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param  id [Integer] the ID of the user whose followers you want to get
+      # @example Fetch users from the authenticated user's network following user whose ID is provided
+      #   Yammer.users_following(1)
+      def users_following(id)
+        get("/api/v1/users/following/#{id}")
+      end
+
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::ApiResponse]
+      # @param  id [Integer] the ID of the user for whom you want to get the users being followed
+      # @example Fetch users from the authenticated user's network followed by the user whose ID is provided
+      #   Yammer.users_followed(1)
+      def users_followed_by(id)
+        get("/api/v1/users/followed_by/#{id}")
+      end
+    end
+  end
+end