platforms-yammer 0.1.0

data/lib/platforms/yammer/api/networks.rb

@@ -0,0 +1,22 @@
+module Platforms
+  module Yammer
+    module Api
+      # Networks on Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Networks < Base
+
+        # Get the user's current Network
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/networkscurrentjson
+        def current options={}, headers={}
+          @connection.get 'networks/current.json', options, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/oauth.rb

@@ -0,0 +1,28 @@
+module Platforms
+  module Yammer
+    module Api
+      # OAuth2 tokens in Yammer, useful for verified admins to impoersonate
+      # other users, or to switch networks.
+      #
+      # @note This class is called Oauth and not OAuth (or OAuth2), because
+      #   of the syntax of the Yammer API path.
+      #   There is no underscore between the O and A.
+      #
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Oauth < Base
+
+        # Get tokens
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/impersonation
+        def tokens options={}, headers={}
+          @connection.get "oauth/tokens.json", options, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/open_graph_objects.rb

@@ -0,0 +1,29 @@
+module Platforms
+  module Yammer
+    module Api
+      # Open Graph Objects in Yammer
+      #
+      # This is read-only through the API.
+      #
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class OpenGraphObjects < Base
+
+        # Get open graph obects
+        # URL is actually a required parameter so require that when
+        # calling this function.
+        # @param url [#to_s] URL of the OG item to get
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/open_graph_objects
+        def get url, options={}, headers={}
+          params = options.merge({url: url})
+          @connection.get 'open_graph_objects.json', params, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/pending_attachments.rb

@@ -0,0 +1,34 @@
+module Platforms
+  module Yammer
+    module Api
+      # Pending attachments in Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class PendingAttachments < Base
+
+        # Add a pending attachment
+        # @param upload_io [Faraday::UploadIO] The file payload
+        # @param options [Hash] Additional options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/pending_attachments
+        # @see https://stackoverflow.com/questions/16725195/upload-files-using-faraday
+        def post upload_io, options={}, headers={}
+          body = { file: upload_io }.reverse_merge(options)
+          @connection.post 'pending_attachments.json', body, headers
+        end
+
+        # Delete a pending attachment
+        # @param id [#to_s] ID of pending attachment to delete
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/pending_attachmentsid
+        def delete id, options={}, headers={}
+          @connection.delete "pending_attachments/#{id}.json", options, headers
+        end
+
+      end
+    end
+  end
+end

data/lib/platforms/yammer/api/relationships.rb

@@ -0,0 +1,39 @@
+module Platforms
+  module Yammer
+    module Api
+      # Relationships in Yammer
+      # @todo confirm documentation, which currently (2020-03-25) is confused
+      # around parameters and mentions updating relationships as part of a
+      # GET request
+      #
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Relationships < Base
+
+        # Get relationships
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/relationshipsjson
+        def get options={}, headers={}
+          @connection.get 'relationships.json', options, headers
+        end
+
+
+        # Update relationships
+        #
+        # It is unclear how exactly this works with subordinates, and "all
+        # three can be passed in one request".
+        #
+        # @param options [Hash] Options for the request body
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/relationshipsjson-1
+        def post options={}, headers={}
+          @connection.post 'relationships.json', options, headers
+        end
+
+      end
+    end
+  end
+end

data/lib/platforms/yammer/api/search.rb

@@ -0,0 +1,22 @@
+module Platforms
+  module Yammer
+    module Api
+      # Search within Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Search < Base
+
+        # Get search results
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/searchjson
+        def get options={}, headers={}
+          @connection.get 'search.json', options, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/streams.rb

@@ -0,0 +1,21 @@
+module Platforms
+  module Yammer
+    module Api
+      # The notification stream in Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Streams < Base
+
+        # Get the notifications stream for the current user
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/streamsnotificationsjson
+        def notifications options={}, headers={}
+          @connection.get "streams/notifications.json", options, headers
+        end
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/subscriptions.rb

@@ -0,0 +1,53 @@
+module Platforms
+  module Yammer
+    module Api
+      # Yammer's subscription (following) management
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Subscriptions < Base
+
+        # Check if the current user is subscribed to (following) another user
+        # @param id [#to_s] The ID of the User
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/subscriptionsto_useridjson
+        def to_user id, options={}, headers={}
+          @connection.get "subscriptions/to_user/#{id}.json", options, headers
+        end
+
+        # Check if the current user is subscribed to (following) a topic (hashtag)
+        # @param id [#to_s] The ID of the User
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/subscriptionsto_topicidjson
+        def to_topic id, options={}, headers={}
+          @connection.get "subscriptions/to_topic/#{id}.json", options, headers
+        end
+
+        # Subscribe to a user or topic.
+        # This usually involves setting target_id and target_type in the JSON body.
+        # @param body [#to_s] Body of the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/subscriptions-1
+        def post body=nil, headers={}
+          @connection.post "subscriptions.json", body, headers
+        end
+
+        # Unsubscribe from a user or topic.
+        # This usually involves setting target_id and target_type in the options hash.
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/subscriptions-1
+        def delete options={}, headers={}
+          @connection.delete "subscriptions.json", options, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/suggestions.rb

@@ -0,0 +1,31 @@
+module Platforms
+  module Yammer
+    module Api
+      # Yammer's suggestions for Users to follow
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Suggestions < Base
+
+        # Get suggested users to follow for the current user
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/suggestionsjson
+        def get options={}, headers={}
+          @connection.get "suggestions.json", options, headers
+        end
+
+        # Decline a suggested user to follow
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/suggestionsidjson
+        def delete suggestion_id, options={}, headers={}
+          @connection.delete "suggestions/#{suggestion_id}.json", options, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/supervisor_mode.rb

@@ -0,0 +1,22 @@
+module Platforms
+  module Yammer
+    module Api
+      # Set supervisor mode in Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class SupervisorMode < Base
+
+        # Toggle supervisor mode
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/api-requests
+        def toggle options={}, headers={}
+          @connection.post "supervisor_mode/toggle.json", options, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/threads.rb

@@ -0,0 +1,23 @@
+module Platforms
+  module Yammer
+    module Api
+      # Threads in Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Threads < Base
+
+        # Get information about a thread
+        # @param id [#to_s] The thread ID
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/threadsidjson
+        def get id, options={}, headers={}
+          @connection.get "threads/#{id}.json", options, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/topics.rb

@@ -0,0 +1,23 @@
+module Platforms
+  module Yammer
+    module Api
+      # Topics in Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Topics < Base
+
+        # Get information about a topic (hashtag)
+        # @param id [#to_s] The topic ID
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/topicsidjson
+        def get id, options={}, headers={}
+          @connection.get "topics/#{id}.json", options, headers
+        end
+
+      end
+    end
+  end
+end
+

data/lib/platforms/yammer/api/uploaded_files.rb

@@ -0,0 +1,22 @@
+module Platforms
+  module Yammer
+    module Api
+      # Uploaded file in Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class UploadedFiles < Base
+
+        # Delete an uploaded file
+        # @param id [#to_s] ID of file to delete
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/uploaded_filesid
+        def delete id, options={}, headers={}
+          @connection.delete "uploaded_files/#{id}.json", options, headers
+        end
+
+      end
+    end
+  end
+end

data/lib/platforms/yammer/api/users.rb

@@ -0,0 +1,109 @@
+module Platforms
+  module Yammer
+    module Api
+      # Users in Yammer
+      # @author Benjamin Elias
+      # @since 0.1.0
+      class Users < Base
+
+        # Get Users
+        #
+        # @note Called #get_users because of the potential confusion with
+        # GET /users/[:id].json
+        #
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/usersjson
+        def get_users options={}, headers={}
+          @connection.get "users.json", options, headers
+        end
+
+        # Get current User
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/userscurrentjson
+        def current options={}, headers={}
+          @connection.get "users/current.json", options, headers
+        end
+
+        # Get a User by id
+        #
+        # @note Called #get_user because of the potential confusion with
+        # GET /users.json
+        #
+        # @param id [#to_s] id of the User
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/usersidjson
+        def get_user id, options={}, headers={}
+          @connection.get "users/#{id}.json", options, headers
+        end
+
+        # Get a User by email
+        # @param address [#to_s] email of the User
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/usersby_emailjsonemailuserdomaincom
+        def by_email address, options={}, headers={}
+          params = options.merge({ email: address })
+          @connection.get "users/by_email.json", params, headers
+        end
+
+        # Get a Users in a Group
+        # @param group_id [#to_s] id of the Group
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/usersin_groupidjson
+        def in_group group_id, options={}, headers={}
+          @connection.get "users/in_group/#{group_id}.json", options, headers
+        end
+
+        # Get Users who have liked a Message
+        # @param message_id [#to_s] id of the Message
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/usersliked_messagemessage_idjson
+        def liked_message message_id, options={}, headers={}
+          @connection.get "users/liked_message/#{message_id}.json", options, headers
+        end
+
+        # Create a new User (verified admins only)
+        # @param body [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/usersjson-1
+        def post body=nil, headers={}
+          @connection.post "users.json", body, headers
+        end
+
+        # Update an existing User (verified admins only)
+        # @param user_id [#to_s] the id of the User to update
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/usersidjson-1
+        def put user_id, options={}, headers={}
+          @connection.put "users/#{user_id}.json", options, headers
+        end
+
+        # Delete an existing User (admins and verified admins only)
+        # @param user_id [#to_s] the id of the User to update
+        # @param options [Hash] Options for the request
+        # @param headers [Hash] Additional headers to send with the request
+        # @return [Faraday::Response] the API response
+        # @see https://developer.yammer.com/docs/usersidjson-2
+        def delete user_id, options={}, headers={}
+          @connection.delete "users/#{user_id}.json", options, headers
+        end
+
+      end
+    end
+  end
+end
+