yammer-client 0.1.0

data/lib/yammer/api/group.rb

@@ -0,0 +1,78 @@
+module Yammer
+  module Api
+    module Group
+
+      # @see https://developer.yammer.com/restapi/#rest-groups
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param [Hash] opts the opts to fetch a thread with
+      # @option opts [Integer] :page
+      # @option opts [String] :sort_by sort groups by created_on, creator, name default order is by number of messages
+      # @option opts [String] :letter groups starting with letter
+      # @example Fetch all groups for authenticated user's network
+      #   Yammer.all_groups
+      def all_groups(opts={})
+        get("/api/v1/groups", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-groups
+      # @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 group ID
+      # @example Fetch data for the thread
+      #   Yammer.get_group(74)
+      def get_group(id)
+        get("/api/v1/groups/#{id}")
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-groups
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param [Hash] opts the opts to fetch a thread with
+      # @option opts [String] :name
+      # @option opts [String] :description
+      # @option opts [Boolean] :private
+      # @option opts [Boolean] :show_in_directory
+      # @example Fetch data for the thread
+      #   Yammer.create_group(74)
+      def create_group(opts={})
+        post("/api/v1/groups", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-groups
+      # @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 group ID
+      # @param [Hash] opts
+      # @option opts [String] :name
+      # @option opts [String] :description
+      # @option opts [Boolean] :private
+      # @option opts [Boolean] :show_in_directory
+      # @example Fetch data for the thread
+      #   Yammer.update_group(74, :name => "new group name")
+      def update_group(id, opts={})
+        post("/api/v1/groups/#{id}", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-groups
+      # @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 group ID
+      # @example Fetch data for the thread
+      #   Yammer.groups_for_user(74)
+      def groups_for_user(id)
+        get("/api/v1/groups/for_user/#{id}")
+      end
+    end
+  end 
+end

data/lib/yammer/api/group_membership.rb

@@ -0,0 +1,32 @@
+module Yammer
+  module Api
+    module GroupMembership
+
+      # @see https://developer.yammer.com/restapi/#rest-groups
+      # @api_path /api/v1/group_memberships/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 group membership ID
+      # @example Fetch data for the thread
+      #   Yammer.get_group_membership(7)
+      def get_group_membership(id)
+        get("/api/v1/group_memberships/#{id}")
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-groups
+      # @api_path /api/v1/group_memberships
+      # @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 group ID
+      # @example Fetch data for the thread
+      #   Yammer.create_group_membership(74)
+      def create_group_membership(id)
+        post("/api/v1/group_memberships", :group_id => id)
+      end
+    end
+  end 
+end

data/lib/yammer/api/message.rb

@@ -0,0 +1,196 @@
+module Yammer
+  module Api
+    module Message
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :newer_than
+      # @example Fetch data for the thread
+      #   Yammer.create_message()
+      def create_message(opts={})
+        post("/api/v1/messages", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @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
+      # @example Fetch data for the thread
+      #   Yammer.delete_message
+      def delete_message(id, opts={})
+        post("/api/v1/messages/#{id}", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @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
+      # @example Fetch data for the thread
+      #   Yammer.get_message
+      def get_message(id, opts={})
+        get("/api/v1/messages/#{id}", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :newer_than
+      # @example Fetch data for the thread
+      #   Yammer.all_messages
+      def all_messages(opts={})
+        get("/api/v1/messages", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :newer_than
+      # @example Fetch data for the thread
+      #   Yammer.messages_sent
+      def messages_sent(opts={})
+        get("/api/v1/messages/sent", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :newer_than
+      # @example Fetch data for the thread
+      #   Yammer.messages_received
+      def messages_received(opts={})
+        get("/api/v1/messages/received", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :newer_than
+      # @example Fetch data for the thread
+      #   Yammer.private_messages
+      def private_messages(opts={})
+        get("/api/v1/messages/private", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :newer_than
+      # @example Fetch data for the thread
+      #   Yammer.followed_messages
+      def followed_messages(opts={})
+        get("/api/v1/messages/following", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @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
+      # @example Fetch data for the thread
+      #   Yammer.messages_from_user
+      def messages_from_user(id, opts={})
+        get("/api/v1/messages/from_user/#{id}", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @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
+      # @example Fetch data for the thread
+      #   Yammer.messages_about_topic
+      def messages_about_topic(id, opts={})
+        get("/api/v1/messages/about_topic/#{id}", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @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
+      # @example Fetch data for the thread
+      #   Yammer.messages_in_group
+      def messages_in_group(id, opts={})
+        get("/api/v1/messages/in_group/#{id}", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @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
+      # @example Fetch data for the thread
+      #   Yammer.messages_liked_by
+      def messages_liked_by(id, opts={})
+        get("/api/v1/messages/liked_by/#{id}", opts)
+      end
+
+      # @see https://developer.yammer.com/restapi/#rest-messages
+      # @api_path /api/v1/messages
+      # @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
+      # @example Fetch data for the thread
+      #   Yammer.messages_in_thread
+      def messages_in_thread(id, opts={})
+        get("/api/v1/messages/in_thread/#{id}", opts)
+      end
+
+    end
+  end 
+end

data/lib/yammer/api/network.rb

@@ -0,0 +1,21 @@
+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::Response]
+      # @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 data for the thread
+      #   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,18 @@
+module Yammer
+  module Api
+    module Notification
+
+      # @see https://developer.yammer.com/restapi/#rest-search
+      # @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::Response]
+      # @example Fetch notifications for authenticated user
+      #   Yammer.notifications
+      def notifications
+        get('/api/v1/streams/notifications')
+      end
+    end
+  end
+end

data/lib/yammer/api/search.rb

@@ -0,0 +1,28 @@
+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::Response]
+      # @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 Fetch data for the thread
+      #   Yammer.search(:search => 'money power women')
+      def search(opts={})
+        get('/api/v1/search.json', opts)
+      end
+    end
+  end
+end

data/lib/yammer/api/thread.rb

@@ -0,0 +1,23 @@
+module Yammer
+  module Api
+    module Thread
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @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,21 @@
+module Yammer
+  module Api
+    module Topic
+
+      # @see https://developer.yammer.com/restapi/#rest-users
+      # @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::Response]
+      # @param id [Integer]
+      # @param [Hash] opts the options to fetch a thread with
+      # @option opts [Integer] :is_followed_by
+      # @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,156 @@
+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::Response]
+      # @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::Response]
+      # @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::Response]
+      # @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::Response]
+      # @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::Response]
+      # @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::Response]
+      # @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::Response]
+      # @param  opts [Hash] A customizable set of opts.
+      # @option opts [Integer] :page
+      # @example Fetch users from the autheticated 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::Response]
+      # @param  opts [Hash] A customizable set of opts.
+      # @option opts [Boolean] :full
+      # @example Fetch users from the autheticated user's network
+      #   Yammer.users_following(1)
+      def users_following(id, opts={})
+        get("/api/v1/users/following/", opts)
+      end
+
+      # @rate_limited Yes
+      # @authentication Requires user context
+      # @raise  [Yammer::Error::Unauthorized] Error raised when supplied user credentials are not valid.
+      # @return [Yammer::Response]
+      # @param  opts [Hash] A customizable set of opts.
+      # @option opts [Boolean] :full
+      # @example Fetch users from the autheticated user's network
+      #   Yammer.users_following(1)
+      def users_followed(id, opts={})
+        get("/api/v1/users/followed_by", opts)
+      end
+    end
+  end
+end