yapper 0.1.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODRmNDFlYTYzZGYzZDJjNzU4NDQwYTg0YWM4YmVhYTA3OGQ2ZGMyMg==
+  data.tar.gz: !binary |-
+    YWQ4NjY0NTMxNDQyOGQ2NDdhZDhlYjExOWVkNTkxMmVjN2IwNmI1ZA==
+SHA512:
+  metadata.gz: !binary |-
+    NjkwZjA3YTk3ZjEzNzY1YTJmYmQyM2Y5YWIyMWQ3NjYyODdmOTg0Mzg3NTFl
+    OTkzNjM3NzZiYmQ0ZTllYmY4NmZjMzlkZjBiZjJmNTY4NjFmZjM0NGJmYjNh
+    NDg1NzdkMjJhNWQ5MjFlNzBmYzc4ODA1NjNlMDkwNzljYmM3ZDk=
+  data.tar.gz: !binary |-
+    ZmNmNzIwZDU3MWQ4YTNhZDdhZDI2YzU0NTZjZmMxN2E1NjhiNzEzNTQzMWU1
+    OTA3ZmUyOTNhZjI4NTNjMDQ1Zjc5YjY2OGRhZDM4ZjljMDA4YzBkODg0MTUz
+    NWY5YzVlYTY0OTk5N2RmNDgyYjYyNDhlY2NmMzhhZDc0N2M5ZTc=

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/HISTORY.md

@@ -0,0 +1,49 @@
+0.1.7 - December 26th, 2013
+----------------
+
+* [synth](https://github.com/synth) Renames Yammer gem to Yapper
+* [synth](https://github.com/synth) Updates the dependency on Yam gem to latest: 2.1.1
+
+0.1.4
+----------------
+
+This release rips out the old api dependencies on Faraday and whatever else handles connection related issues and passed it all off to Yammer's own Yam gem(which itself uses Faraday).
+
+Improved api support
+
+    yam.users
+    yam.in_group  
+
+Better Exception Handling
+
+    It was completely broken, now you can catch all sorts of exceptions with Yammer api based upon http status:
+    
+    - 400: Yammer::BadRequest
+    - 401: Yammer::Unauthorized
+    - 403: Yammer::Forbidden
+    - 404: Yammer::NotFound
+    - 406: Yammer::NotAcceptable
+    - 500: Yammer:InternalServerError
+    - 502: Yammer::BadGateway
+    - 503: Yammer::ServiceUnavailable
+    
+0.1.2 - April 19th, 2012
+-------------------------
+* [ybenjo](https://github.com/ybenjo) added search, groups and suggestions api support.
+
+0.1.1 - Sept 21st, 2011
+-------------------------
+* [Rob Warner](https://github.com/hoop33) added about_topic and user[:id]
+
+0.1.0 - July 15th, 2011
+-------------------------
+* First public release
+* Basic README.md
+
+0.0.2 - July 9th, 2011
+-------------------------
+* Adding support for messages in threads
+
+0.0.1 - July 9th, 2011
+-------------------------
+* [Initial release](http://github.com/roadly/yammer)

data/LICENSE.md

@@ -0,0 +1,21 @@
+Copyright (c) 2011, Peter Philips
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,90 @@
+The Yammer Ruby Gem
+====================
+A Ruby wrapper for the Yammer REST APIs
+
+This was originally forked from http://github.com/roadly/yammer.  I had to rename it due to namespace collisions with the latest Yam gem(which really users Yammer modules)
+
+Installation
+------------
+    gem install yapper
+
+What's new in 0.1.7?
+----------------
+
+Renames Yammer gem to Yapper
+Updates the dependency on Yam gem to latest: 2.1.1
+
+See HISTORY.md for more
+
+
+Getting Started
+---------------
+
+You should probably be using Omniauth(http://github.com/intridea/omniauth), cuz its awesome, and be following that flow.  Ryan Bate's excellent RailsCasts are also a great reference: http://railscasts.com/episodes/236-omniauth-part-2
+
+Whatever controller handles the callback, you will have access to a "credentials" key in the oauth object which has an "expires" key, and a "token" key.  I stash that entire object in a serialized string in my Authentication model.  This token is what you will need.
+
+    token = current_user.authentications.find_by_provider("yammer").credentials.token
+    yam = Yammer.new(oauth_token: token)
+    
+That's it!
+
+    yam.groups
+    yam.users
+
+
+TODO
+----
+
+* Specs, specs and specs ... we lack tests even basic ones.
+* Support for the following APIs
+  * Likes
+  * Topics
+  * Users
+  * Group Memberships
+  * Networks
+  
+Contributing
+------------
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing tests
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing [issues](https://github.com/roadly/yammer/issues)
+* by reviewing patches
+
+All contributors will be added to the [HISTORY](https://github.com/roadly/yammer/blob/master/HISTORY.md)
+file and will receive the respect and gratitude of the community.
+
+Submitting an Issue
+-------------------
+We use the [GitHub issue tracker](https://github.com/roadly/yammer/issues) to track bugs and
+features. Before submitting a bug report or feature request, check to make sure it hasn't already
+been submitted. You can indicate support for an existing issue by voting it up. When submitting a
+bug report, please include a [Gist](https://gist.github.com/) that includes a stack trace and any
+details that may be necessary to reproduce the bug, including your gem version, Ruby version, and
+operating system. 
+
+Submitting a Pull Request
+-------------------------
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add documentation for your feature or bug fix.
+5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+6. Commit and push your changes.
+7. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+
+
+Copyright
+---------
+Copyright (c) 2011, Peter Philips <pete <-at-> p373.net>
+See [LICENSE](https://github.com/roadly/yammer/blob/master/LICENSE.md) for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/faraday/request/gateway.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Request::Gateway < Faraday::Middleware
+    def call(env)
+      url = env[:url].dup
+      url.host = @gateway
+      env[:url] = url
+      @app.call(env)
+    end
+
+    def initialize(app, gateway)
+      @app, @gateway = app, gateway
+    end
+  end
+end

data/lib/faraday/request/multipart_with_file.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Request::MultipartWithFile < Faraday::Middleware
+    def call(env)
+      if env[:body].is_a?(Hash)
+        env[:body].each do |key, value|
+          if value.is_a?(File)
+            env[:body][key] = Faraday::UploadIO.new(value, mime_type(value), value.path)
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def mime_type(file)
+      case file.path
+      when /\.jpe?g/i
+        'image/jpeg'
+      when /\.gif$/i
+        'image/gif'
+      when /\.png$/i
+        'image/png'
+      else
+        'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/faraday/request/yammer_oauth.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+module Faraday
+  class Request::YammerOAuth < Faraday::Middleware
+    dependency 'simple_oauth'
+
+    def call(env)
+      params = env[:body] || {}
+      signature_params = params
+
+      params.map{ |k,v| signature_params = {} if v.respond_to?(:content_type) }
+
+      header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
+
+      env[:request_headers]['Authorization'] = header.to_s
+
+      @app.call(env)
+    end
+
+    def initialize(app, options)
+      @app, @options = app, options
+    end
+  end
+end

data/lib/faraday/response/raise_http_4xx.rb

@@ -0,0 +1,43 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp4xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 400
+        raise Yammer::BadRequest.new(error_message(env), env[:response_headers])
+      when 401
+        raise Yammer::Unauthorized.new(error_message(env), env[:response_headers])
+      when 403
+        raise Yammer::Forbidden.new(error_message(env), env[:response_headers])
+      when 404
+        raise Yammer::NotFound.new(error_message(env), env[:response_headers])
+      when 406
+        raise Yammer::NotAcceptable.new(error_message(env), env[:response_headers])
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]}#{error_body(env[:body])}"
+    end
+
+    def error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        ": #{body['error']}"
+      elsif body['errors']
+        first = Array(body['errors']).first
+        if first.kind_of? Hash
+          ": #{first['message'].chomp}"
+        else
+          ": #{first.chomp}"
+        end
+      end
+    end
+  end
+end

data/lib/faraday/response/raise_http_5xx.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp5xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 500
+        raise Yammer::InternalServerError.new(error_message(env, "Something is technically wrong."), env[:response_headers])
+      when 502
+        raise Yammer::BadGateway.new(error_message(env, "Yammer is down or being upgraded."), env[:response_headers])
+      when 503
+        raise Yammer::ServiceUnavailable.new(error_message(env, "(__-){ Yammer is over capacity."), env[:response_headers])
+      end
+    end
+
+    private
+
+    def error_message(env, body=nil)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{[env[:status].to_s + ':', body].compact.join(' ')} Check http://status.Yammer.com/ for updates on the status of the Yammer service."
+    end
+  end
+end

data/lib/yapper.rb

@@ -0,0 +1,27 @@
+require 'yammer'
+require 'yapper/api'
+require 'yapper/client'
+require 'yapper/configuration'
+require 'yapper/error'
+
+module Yapper
+  extend Configuration
+  class << self
+    # Alias for Yapper::Client.new
+    #
+    # @return [Yapper::Client]
+    def new(options={})
+      Yapper::Client.new(options)
+    end
+
+    # Delegate to Yammer::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/yapper/api.rb

@@ -0,0 +1,24 @@
+require 'yapper/authentication'
+require 'yapper/configuration'
+require 'yapper/connection'
+require 'yapper/request'
+
+module Yapper
+  # @private
+  class API
+    include Connection
+    include Request
+    include Authentication
+
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Yapper.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+  end
+end

data/lib/yapper/authentication.rb

@@ -0,0 +1,23 @@
+module Yapper
+  # @private
+  module Authentication
+    # Check whether user is authenticated
+    #
+    # @return [Boolean]
+    def authenticated?
+      authentication.values.all?
+    end
+    
+    private
+
+    # Authentication hash
+    #
+    # @return [Hash]
+    def authentication
+      {
+        oauth_token: oauth_token
+      }
+    end
+
+  end
+end

data/lib/yapper/client.rb

@@ -0,0 +1,28 @@
+module Yapper
+  # Wrapper for the Yammer REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in {http://developer.yammer.com/api/ the Yammer API Documentation}.
+  # @note From Yammer: When polling for messages, do not exceed one poll per minute. Clients polling excessively will be blocked. However, you may sometimes need to fetch messages more frequently than once per minute, for example, if a user flips between "following", "sent" and "received" feeds quickly), and this is allowed for a few requests. Do not attempt to decrease message latency in your client by checking for new messages more frequently than once per minute.
+  class Client < API
+    # Require client method modules after initializing the Client class in
+    # order to avoid a superclass mismatch error, allowing those modules to be
+    # Client-namespaced.
+    require 'yapper/client/messages'
+    require 'yapper/client/feed'
+    require 'yapper/client/users'
+    require 'yapper/client/search'
+    require 'yapper/client/suggestions'
+    require 'yapper/client/groups'
+    require 'yapper/client/activity'
+
+    alias :api_endpoint :endpoint
+
+    include Yapper::Client::Messages
+    include Yapper::Client::Feed
+    include Yapper::Client::Users
+    include Yapper::Client::Search
+    include Yapper::Client::Suggestions
+    include Yapper::Client::Groups
+    include Yapper::Client::Activity
+  end
+end

data/lib/yapper/client/activity.rb

@@ -0,0 +1,9 @@
+module Yapper
+  class Client
+    module Activity
+      def new_activity(options={})
+        response = post('activity', options)
+      end
+    end
+  end
+end

data/lib/yapper/client/feed.rb

@@ -0,0 +1,163 @@
+module Yapper
+  class Client
+    # Defines methods related to feeds (or viewable messages)
+    module Feed
+      # Returns the 20 most recent messages in this network. Corresponds to the "Company Feed" tab on the website.
+      #
+      # @note Developers should note that a strict rate limit is applied to all API requests, so clients should never poll for new messages more frequently than every 30 seconds to ensure that the user is still able to use the API for posting messages, etc.
+      # @format `:json`, `:xml`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Hashie::Mash]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent messages in this network.
+      #   Yammer.messages
+      def messages(options={})
+        response = get('messages', options)
+        format.to_s.downcase == 'xml' ? response['response']['messages'] : response
+      end
+
+      # Returns the 20 sent messages by the current logged in user.
+      # Alias for `/api/v1/messages/from_user/logged-in_user_id.format`. Corresponds to the "Sent" tab on the website.
+      # 
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Hashie::Mash]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent sent messages
+      #   Yammer.messages_sent
+      def messages_sent(options={})
+        response = get('messages/sent', options, :json)
+      end
+
+      # Messages received by the logged-in user. Corresponds to the "Received" tab on the website.
+      # 
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Hashie::Mash]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent received messages
+      #   Yammer.messages_received
+      def messages_received(options={})
+        response = get('messages/received', options, :json)
+      end
+
+      # Private Messages (aka Direct Messages) for the logged-in user. Corresponds to the "Direct Messages" section on the website.
+      # 
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Hashie::Mash]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent private messages
+      #   Yammer.direct_messages
+      def direct_messages(options={})
+        response = get('messages/private', options, :json)
+      end
+
+      # Messages followed by the logged-in user. Corresponds to the "My Feed" tab on the website.
+      # 
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Hashie::Mash]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent received messages in my feed
+      #   Yammer.my_feed
+      def my_feed(options={})
+        response = get('messages/following', options, :json)
+      end
+
+      # Messages sent by the user with the given ID. Corresponds to the messages on a user profile page on the website.
+      # 
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer, String] A user ID or screen name.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Hashie::Mash]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the 20 most recent messages from the user
+      #   Yammer.messages_from("bruno")
+      def messages_from(id, options={})
+        response = get("messages/from_user/#{id}", options, :json)
+      end
+
+      # Messages that have the topic with given ID. Corresponds to the messages on a topic's page on the website. 
+      # 
+      # @note Important to note that the XML format returns a different structure than the JSON one. So we only support the JSON format for this method.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer] A topic ID
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [String] :threaded Accepts true or extended. When true, will only return the first message in each thread. This parameter is intended for applications which display message threads collapsed. threaded=extended will return the thread starter messages in order of most recently active as well as the two most recent messages, as they are viewed in the default view on our website.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Hashie::Mash]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the messages in topic with ID 1234567
+      #   Yammer.about_topic(1234567)
+      def about_topic(id, options={})
+        response = get("messages/about_topic/#{id}", options, :json)
+      end
+
+      # Messages in the thread with the given ID. Corresponds to the page you'd see when clicking on "in reply to" on the website. 
+      #
+      # @note Does not accept the threaded parameter.
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited true
+      # @param id [Integer] A thread ID
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :older_than Returns only messages older than the message ID specified. This is useful for paginating messages.
+      # @option options [Integer] :newer_than Return only messages newer than the message ID specified. This should always be used when polling for new messages.
+      # @option options [Integer] :limit Return only the specified number of messages. Works for `threaded=true` and `threaded=extended`.
+      # @return [Hashie::Mash]
+      # @see http://developer.yammer.com/api/#message-viewing
+      # @example Return the messages in the thread with ID 1234567
+      #   Yammer.thread(1234567)
+      def thread(id, options={})
+        response = get("messages/in_thread/#{id}", options)
+        format.to_s.downcase == 'xml' ? response['response']['messages'] : response
+      end
+    end
+  end
+end

data/lib/yapper/client/groups.rb

@@ -0,0 +1,44 @@
+module Yapper
+  class Client
+    # Defines methods related to groups
+    module Groups
+      # Get groups information.
+      # @see https://developer.yammer.com/api/#groups
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited unconfirmed
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :page 20 groups will be shown per page.
+      # @option options [String] :letter Return groups beginning with the given letter.
+      # @option options [messages|members|privacy|created_at|creator] :sort_by Results will be returned sorted by one of the above options instead of the default behavior of sorting by number of messages.
+      # @option options [String] :reverse Return results in reverse order if uses true.
+      # @option options [String] :private Used when creating or updating groups to make them private if uses true.
+      # @return [Hashie::Mash] Informations of groups.
+      def groups(options={})
+        get("groups", options)
+      end
+
+      # Get specific group information.
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited unconfirmed
+      # @param id [Integer] The id of specific group.
+      # @return [Hashie::Mash] Informations of group which id is #{id}.
+      def group(id, options={})
+        get("groups/#{id}", options)
+      end
+
+      # Create/Update group.
+      #
+      # @authenticated true
+      # @rate_limited unconfirmed
+      # @param name [String] The name of group.
+      # @param private [String] Used true when creating or updating groups to make them private.
+      def create_group(name, options={})
+        post('groups', options.merge({:name => name}))
+      end
+    end
+  end
+end

data/lib/yapper/client/messages.rb

@@ -0,0 +1,29 @@
+module Yapper
+  class Client
+    # Defines methods related to manipulating messages
+    module Messages
+      # Creates a new message from the authenticating user
+      #
+      # @note A status update with text identical to the authenticating user's current status will be ignored to prevent duplicates.
+      # @format `:json`, `:xml`
+      # @authenticated true
+      # @rate_limited false
+      # @param body [String] The text of your message.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :in_reply_to_message_id The ID of an existing message that the message is in reply to.
+      # @option options [Integer] :group_id The ID of the group in which this message belongs.
+      # @option options [Integer] :replied_to_id The message ID this message is in reply to, if applicable.
+      # @option options [Integer] :direct_to_id the ID of the user to which this message will be sent as a private message.
+      # @option options [String] :broadcast If `true` this message should be broadcasted to all users. *Must be an admin*
+      # @option options [Integer] :topic*n* Topics to apply to the message. Can use topic1 through topic20.
+      # @return [Hashie::Mash] The created message.
+      # @see http://developer.yammer.com/api/#messages-manipulating
+      # @example Creates a new message for the authenticating user
+      #   Yammer.update("I just posted a status update via the Yammer Ruby Gem!")
+      def update(message, options={})
+        response = post('messages', options.merge(:body => message))
+        format.to_s.downcase == 'xml' ? response['response']['messages'] : response
+      end
+    end
+  end
+end

data/lib/yapper/client/search.rb

@@ -0,0 +1,24 @@
+module Yapper
+  class Client
+    # Defines methods related to search
+    module Search
+      # Returns the 20 lists of messages, users, tags and groups that match the user's search query.
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited ***
+      # @param query [String] The search query.
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :page Only 20 results of each type will be returned for each page, but a total count is returned with each query. page=1 (the default) will return items 1-20, page=2 will return items 21-30, etc.
+      # @option options [Integer] :num_per_page limit of search results, up to a maximum of 20, the default value. 
+      # @return [Hashie::Mash]
+      # @see https://developer.yammer.com/api/#search
+      # @example 
+      #   Yammer.search("my boss")
+      def search(query, options={})
+        get('search', options.merge({:search => query}))
+      end
+    end
+  end
+end
+

data/lib/yapper/client/suggestions.rb

@@ -0,0 +1,29 @@
+module Yapper
+  class Client
+    # Defines methods to get/declines suggestions.
+    module Suggestions
+      # Return suggested groups and users.
+      #
+      # @format `:json`
+      # @authenticated true
+      # @rate_limited 
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :limit Returns only Return only the specified number of suggestions.
+      # @return [Hashie::Mash]
+      # @see https://developer.yammer.com/api/#suggestions
+      # @example
+      # Yammer.suggestions
+      def suggestions(options={})
+        get('suggestions', options)
+      end
+
+      # Decline a suggestion specfic id.
+      # @param id [Integer/String] When declining a suggestion, pass its id.
+      # @example
+      # Yammer.decline_suggestion(12345)
+      def decline_suggestion(id)
+        delete("suggestions/#{id}")
+      end
+    end
+  end
+end

data/lib/yapper/client/users.rb

@@ -0,0 +1,31 @@
+module Yapper
+  class Client
+    # Defines methods related to manipulating users
+    module Users
+      def find_by_id(id, options={})
+        response = get("users/#{id}", options, :json)
+      end
+
+      def users(options={})
+        response = get("users", options, :json)
+      end
+      
+      def in_group(group_id, options={})
+        response = get("users/in_group/#{group_id}", options, :json)
+      end
+
+      def current(options={})
+        response = get("users/current", options, :json)
+      end
+
+      def followers(name, options={})
+        response = get("users/following/#{name}", options, :json)
+      end
+
+      def following(email, options={})
+        response = get("users/by_email?email=#{email}", options, :json)
+      end
+
+    end
+  end
+end

data/lib/yapper/configuration.rb

@@ -0,0 +1,78 @@
+require 'yammer/version'
+
+module Yapper
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Yammer::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :endpoint,
+      :api_path_prefix,
+      :format,
+      :gateway,
+      :oauth_token,
+      :proxy,
+      :user_agent].freeze
+
+    # The adapter that will be used to connect if none is set
+    DEFAULT_ADAPTER = :net_http
+
+    # The endpoint that will be used to connect if none is set
+    #
+    # @note This is configurable in case you want to use HTTP instead of HTTPS, specify a different API version.
+    DEFAULT_ENDPOINT = 'https://www.yammer.com/'.freeze
+
+    DEFAULT_API_VERSION = 'v1'.freeze
+
+    DEFAULT_API_PATH_PREFIX = 'api/'+DEFAULT_API_VERSION
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is preferred over XML because it is more concise and faster to parse.
+    DEFAULT_FORMAT = :json
+
+    # By default, don't set a user oauth token
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The value sent in the 'User-Agent' header if none is set
+    DEFAULT_USER_AGENT = "Yammer Ruby Gem #{Yapper::VERSION}".freeze
+
+    DEFAULT_GATEWAY = nil
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.api_path_prefix    = DEFAULT_API_PATH_PREFIX
+      self.format             = DEFAULT_FORMAT
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.proxy              = DEFAULT_PROXY
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.gateway            = DEFAULT_GATEWAY
+      self
+    end
+  end
+end

data/lib/yapper/connection.rb

@@ -0,0 +1,10 @@
+module Yapper
+  # @private
+  module Connection
+    private
+
+    def connection(format=format)
+      Yammer::Client.new(access_token: oauth_token, endpoint: endpoint)
+    end
+  end
+end

data/lib/yapper/error.rb

@@ -0,0 +1,102 @@
+module Yapper
+
+  # This gem seems to monkey patch faraday to catch certain exceptions
+  # and even that attempt does not seem to be loaded anywhere, so instead
+  # we'll catch the error on every request(and possibly elsewhere)
+  # and then pass the exception to this class who will figure out the proper 
+  # high level exception to raise
+  class ErrorProxy
+    def self.new(exception)
+      return self.determine_exception(exception)
+    end
+    
+    def self.determine_exception(exception)
+      exception = exception
+      message = exception.message
+      status = exception.response[:status]
+      headers = exception.response[:headers]
+
+      case status.to_i
+      when 400
+        Yapper::BadRequest.new(error_message(message), headers)
+      when 401
+        Yapper::Unauthorized.new(error_message(message), headers)
+      when 403
+        Yapper::Forbidden.new(error_message(message), headers)
+      when 404
+        Yapper::NotFound.new(error_message(message), headers)
+      when 429
+        Yapper::TooManyRequests.new(error_message(message), headers)
+      when 406
+        Yapper::NotAcceptable.new(error_message(message), headers)
+      when 500
+        Yapper::InternalServerError.new(error_message("Something is technically wrong."), headers)
+      when 502
+        Yapper::BadGateway.new(error_message("Yammer is down or being upgraded."), headers)
+      when 503
+        Yapper::ServiceUnavailable.new(error_message("(__-){ Yammer is over capacity."), headers)
+      else
+        Exception.new("Unhandled Exception Status: #{status} - #{message}")
+      end      
+    end
+  
+    private
+    def self.error_message(msg)
+      #TODO: this can be used in the future to print nicer messages
+      msg
+    end
+  end
+
+  # Custom error class for rescuing from all Yammer errors
+  class Error < StandardError
+    attr_reader :http_headers
+
+    def initialize(message, http_headers)
+      @http_headers = Hash[http_headers]
+      super message
+    end
+
+    def ratelimit_reset
+      Time.at(@http_headers.values_at('x-ratelimit-reset', 'X-RateLimit-Reset').detect{|value| value}.to_i)
+    end
+
+    def ratelimit_limit
+      @http_headers.values_at('x-ratelimit-limit', 'X-RateLimit-Limit').detect{|value| value}.to_i
+    end
+
+    def ratelimit_remaining
+      @http_headers.values_at('x-ratelimit-remaining', 'X-RateLimit-Remaining').detect{|value| value}.to_i
+    end
+
+    def retry_after
+      [(ratelimit_reset - Time.now).ceil, 0].max
+    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
+
+  # Raised when you hit Yammer's request rate limit
+  class TooManyRequests < Error;end
+end

data/lib/yapper/request.rb

@@ -0,0 +1,76 @@
+module Yapper
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, format=format)
+      respond request(:get, path, options, format)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, format=format)
+      respond request(:post, path, options, format)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, format=format)
+      respond request(:put, path, options, format)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, format=format)
+      respond request(:delete, path, options, format)
+    end
+
+    private
+
+    def respond(raw_response)
+      body = raw_response.body
+      case body
+      when Array
+        body.map{|item| Hashie::Mash.new(item)}
+      when Hash
+        Hashie::Mash.new(body)
+      else
+        raise "Unhandled response type"
+      end
+    end
+
+    # Perform an HTTP request
+    def request(method, path, options, format)
+      begin
+        case method.to_sym
+        when :get, :delete
+          response = connection.send(method, formatted_path(path, format), options)
+        when :post
+          response = connection.send(method, formatted_path(path, format), options)
+        when :put
+          raise "PUT verbs are not yet supported!"
+          # request.path = formatted_path(path, format)
+          # request.body = options unless options.empty?
+        end
+      
+      #TODO: format is not obeyed.  From Yam we get back an array of objects
+      response
+      
+      rescue MultiJson::DecodeError
+        Hashie::Mash.new
+      rescue Faraday::Error::ClientError => e
+        raise Yapper::ErrorProxy.new(e)
+
+      end
+    end
+
+    def formatted_path(path, format)
+      #paths must have a leading /
+      path = "/#{path}" if path[0] != "/"
+      path = "/#{api_path_prefix}#{path}"
+      
+      case format.to_s.downcase
+      when 'json', 'xml'
+        [path, format].compact.join('.')
+      when 'raw'
+        [path, Yapper.format].compact.join('.')
+      end
+    end
+  end
+end

data/lib/yapper/version.rb

@@ -0,0 +1,4 @@
+module Yapper
+  # The version of the gem
+  VERSION = '0.1.7'.freeze unless defined?(::Yapper::VERSION)
+end

data/yapper.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yapper/version"
+
+Gem::Specification.new do |gem|
+  gem.add_runtime_dependency 'yam', '2.0.1'
+  gem.authors = ["Bruno Mattarollo, Peter Philips"]
+  gem.description = %q{A Ruby wrapper for the Yammer REST API}
+  gem.email = ['bruno.mattarollo@gmail.com', 'pete@p373.net']
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.files = `git ls-files`.split("\n")
+  gem.homepage = 'https://github.com/synth/yapper'
+  gem.name = 'yapper'
+  gem.require_paths = ['lib']
+  gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+  gem.summary = %q{Ruby wrapper for the Yammer API}
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.version = Yapper::VERSION.dup
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: yapper
+version: !ruby/object:Gem::Version
+  version: 0.1.7
+platform: ruby
+authors:
+- Bruno Mattarollo, Peter Philips
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yam
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: A Ruby wrapper for the Yammer REST API
+email:
+- bruno.mattarollo@gmail.com
+- pete@p373.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- HISTORY.md
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/faraday/request/gateway.rb
+- lib/faraday/request/multipart_with_file.rb
+- lib/faraday/request/yammer_oauth.rb
+- lib/faraday/response/raise_http_4xx.rb
+- lib/faraday/response/raise_http_5xx.rb
+- lib/yapper.rb
+- lib/yapper/api.rb
+- lib/yapper/authentication.rb
+- lib/yapper/client.rb
+- lib/yapper/client/activity.rb
+- lib/yapper/client/feed.rb
+- lib/yapper/client/groups.rb
+- lib/yapper/client/messages.rb
+- lib/yapper/client/search.rb
+- lib/yapper/client/suggestions.rb
+- lib/yapper/client/users.rb
+- lib/yapper/configuration.rb
+- lib/yapper/connection.rb
+- lib/yapper/error.rb
+- lib/yapper/request.rb
+- lib/yapper/version.rb
+- yapper.gemspec
+homepage: https://github.com/synth/yapper
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.5
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Yammer API
+test_files: []