yammer-client 0.1.0

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.rbc
+.lock
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# OS generated files #
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+Icon?
+ehthumbs.db
+Thumbs.db

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+
+branches:
+  only:
+    - master

data/.yardopts

@@ -0,0 +1,10 @@
+--no-private
+--protected
+--tag api_path:"Rest API path"
+--tag rate_limited:"Rate Limited?"
+--tag authentication:"Authentication"
+--markup markdown
+-
+CHANGELOG.md
+LICENSE.md
+README.md

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :test do
+  gem 'json', :platforms => :ruby_18
+  gem 'rspec', '>= 2.11'
+  gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
+  gem 'webmock', '>= 1.10.1'
+end
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Kevin Mutyaba
+
+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,265 @@
+Yammer Client
+=============
+
+[![Build Status](https://travis-ci.org/tiabas/yammer-client.png?branch=master)](https://travis-ci.org/tiabas/yammer-client)
+
+A Yammer Ruby gem
+
+## Documentation
+
+[http://rdoc.info/github/tiabas/yammer-client][documentation]
+
+[documentation]: http://rdoc.info/github/tiabas/yammer-client 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yammer-client'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install yammer-client
+```
+
+## Configuration
+
+The Yammer API requires authentication for access to certain endpoints. Below are the basic steps to get this done. For more information, take a look at Yammer's Developer Guide <http://developer.yammer.com/files/2012/10/PlatformDeveloperGuide.pdf>
+
+
+### Register your application
+
+1. Sign in to Yammer
+
+2. Go to `https://www.yammer.com/client_applications`
+
+3. Click on 'Register New App' and fill out the registration form
+
+4. Make note of your client_id and client_secret they will be needed for token authorization 
+
+
+### Obtaining an access token
+
+1. Construct the following URL using the client_id you received `https://www.yammer.com/dialog/oauth?client_id=[:client_id]`
+
+2. Have your users follow the URL you constructed above to allow your application to access their data 
+
+3. After allowing access, your users will be redirected to your callback URL `http://[:redirect_uri]?code=[:code]`
+
+4. Exchange the code for an access token by making an HTTP GET request to `https://www.yammer.com/oauth2/access_token.json?client_id=[:client_id]&client_secret=[:client_secret]&code=[:code]`
+
+5. The authorization server will respond with an access token
+
+```
+"access_token": {
+  "view_subscriptions": true,
+  "expires_at": null,
+  authorized_at": "2011/04/06 16:25:46 +0000",
+  "modify_subscriptions": true,
+  "modify_messages": true,
+  "network_permalink": "yammer-inc.com",
+  "view_members": true,
+  "view_tags": true,
+  "network_id": 155465488,
+  "user_id": 1014216,
+  "view_groups": true,
+  "token": "abcdefghijklmn",
+  "network_name": "Yammer",
+  "view_messages": true,
+  "created_at": "2011/04/06 16:25:46 +0000"
+}
+```
+
+### Configuring yammer-client
+
+To view the current state of the client use the `options` method
+
+```ruby
+require 'yammer'
+
+Yammer.options
+
+# => {:site_url=>"https://www.yammer.com", :client_id=>nil, :client_secret=>nil, :access_token=>nil, :http_adapter=>Yammer::HttpConnection, :connection_options=>{:max_redirects=>5, :use_ssl=>true}} 
+```
+
+You may change this configuration by using the `configure` method
+
+```ruby
+Yammer.configure do |c|
+  c.client_id = '[client_id]'
+  c.client_secret = '[client_secret]'
+  c.token = '[access_token]'
+end
+
+# => Yammer 
+```
+
+At this point, your new settings will take effect
+
+```ruby
+Yammer.options
+
+# => {:site_url=>"https://www.yammer.com", :client_id=>'[client_id]', :client_secret=>'[client_secret]', :access_token=>'[access_token]', :http_adapter=>Yammer::HttpConnection, :connection_options=>{ :max_redirects=>5, :use_ssl=>true }} 
+```
+
+## Usage
+
+ `yammer-client` provides two ways to access Yammer's API. One of these ways is by using HTTP helper methods on and instance of `Yammer::Client`. The other 
+ way is using methods on the object models that come bundled with this gem.
+
+### Using the client
+
+1. Create an instance of the Yammer client
+
+```ruby
+yamr = Yammer::Client.new(
+        :client_id     => 'vAbMcg9qjgKsp4jjpm1pw',
+        :client_secret => 'Wn0kp7Lu0TCY4GtZWkmSsqGErg10DmMADyjWkf2U',
+        :access_token  => 'HqsKG3ka9Uls2DxahNi78A'
+      )
+```
+
+2. Call methods on the instance:
+
+**User**
+
+*find a user by email*
+
+```ruby
+yamr.get_user_by_email('user@example.com')
+```
+
+*find a user by user id*
+
+```ruby
+yamr.get_user('1588')
+```
+
+*get the current user*
+
+```ruby
+yamr.current_user
+```
+
+
+**Message**
+
+*post a update as the current user*
+
+```ruby
+yamr.create_message(:body => 'status update')
+```
+
+*send a private message to another Yammer user*
+
+```ruby
+yamr.create_message(:body => 'private message', :direct_to_id => 24)
+```
+
+*send a message with an Open Graph Object as an attachment*
+
+```ruby
+yamr.create_message(:body => 'here is my open graph object', og_url: "https://www.yammer.com/example/graph/31415926")
+```
+
+
+**Search**
+
+*search for a term within the context of current user*
+
+```ruby
+yamr.search(:search => 'thekev', :model_types => 'users;groups')
+```
+
+**Thread**
+*fetch a thread with a given id*
+```ruby
+yamr.get_thread(42, :model_types => 'users;groups')
+```
+
+
+### Using the object models
+
+Object models are classes that take away the hussle of having to deal with parsing the JSON that Yammer returns for
+any given request. Each model has accessor metods for all keys contained in the JSON response for a given model type. 
+
+
+**User**
+
+*get the current user*
+
+
+```ruby
+u = Yammer::User.current
+
+#=> #<Yammer::User:0x007f9f4b0c39c8>
+
+u.full_name
+
+#=> 'Kevin Mutyaba'
+
+u.update!(:job_title => 'k0dR')
+
+```
+
+
+**Thread**
+
+*fetch a thread with a given id*
+
+```ruby
+
+t = Yammer::Thread.get(3)
+
+# view the participants in the thread
+
+parts = t.participants
+#=> [{:type=>"user", :id=>18}, {:type=>"user", :id=>64}]
+
+
+# view the participants in the thread as user object models
+
+peepl = t.people
+#=> [#<Yammer::User:0x007f9f4c086630 @modified_attributes={}, @attrs={}, @new_record=false, @id=18>, #<Yammer::User:0x007f9f4c086568 @modified_attributes={}, @attrs={}, @new_record=false, @id=64>] 
+
+
+# object models are lazyly loaded
+
+peepl[0]
+#=> #<Yammer::User:0x007f9f4c086568 @modified_attributes={}, @attrs={}, @new_record=false, @id=18> 
+
+# calling an accessor on a model will hydrate it
+
+peepl[0].permalink
+#=> 'thekev'
+
+peepl[0]
+#=> #<Yammer::User:0x007f9f4c086630 @modified_attributes={}, @attrs={:last_name=>"Mutyaba", :network_id=>1, :first_name=>"Kevin", :id => 18,  :permalink=>"thekev" }, @network_id=1, @first_name="Kev", @full_name="Tiaba", @permalink="thekev", @id=18 > 
+```
+
+## Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
+version:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+## Copyright
+Copyright (c) 2013 Kevin Mutyaba
+See [LICENSE][license] for details.
+[license]: https://github.com/tiabas/yammer-client/blob/master/LICENSE.md

data/Rakefile

@@ -0,0 +1,12 @@
+#Rakefile
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = true
+end
+
+desc "Run spec"
+task :default => :spec
+task :test    => :spec

data/certs/tiabas-public.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAh0aWFi
+YXNuazEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+MB4XDTEzMDMwMzA2MjAxNVoXDTE0MDMwMzA2MjAxNVowPzERMA8GA1UEAwwIdGlh
+YmFzbmsxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMsmVsErcNuwQLKLh9T6
+a57QiK35g9zjpID2pUBn4alMTmIeAXg2bXWLdAzU0swcjmaGBWz5AaZeqTnnBveO
+ZDoH6e811uuRjJMYCkLQxhlghEB0TQkAqOnxlj80TN2jFw+YFWLmSnxR4PBonvpp
+YwWAY0ylqM54FPRhaAIYC5/3Pvx1SYL9/Us0376HEpV0Rty6VXz7tUzv8vFki5ot
+gyfp5ceWiYIZjQ9Uvhm4luJSfXci13UHZ0AeO7E1padWlx3z8hZIvjawueTGRe5p
+BgZlI0+xV2ogvAlu8/NCy0hWUwcpnvRdPyBVDRMli8gXGE9jNv8dBWe67vdjzGSk
+YDUCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFInh
+qvJkuISNqDOcsrBRotZC0qolMB0GA1UdEQQWMBSBEnRpYWJhc25rQGdtYWlsLmNv
+bTAdBgNVHRIEFjAUgRJ0aWFiYXNua0BnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
+ggEBAEGb4gRDulJ9jkf5oRLydfw9UZi6fVWj6aaiJfbbT5NLotpVaWnWdCOO7hy8
+HDPYWN430zLwr0ODOU9XNueKnEkhnBRiYkcQ0JmYddPkL57kp0qlH4g2IqQfQV2W
+1b7sE410zFHn55B5nihQY3c0MMSL7wq9Dz2EktbIMikf6sG6zfUgYFE4IQGi2RbO
+xa5fnTWt7KB5DD02HnHLTZ9Hl2kxlPyWwyjREwNwEjPoSUJFEBiosvAml8frUDA9
+j6fATg/4fqpgILPVqFIGZOMJDFcJy/oehwwxLu5XMx88WFD9jT1vRj77D7iPLbXd
+rfGs/qCJKgifXd/1am5hlAH5jXU=
+-----END CERTIFICATE-----

data/lib/yammer.rb

@@ -0,0 +1,28 @@
+require 'yammer/version'
+require 'yammer/error'
+require 'yammer/http_connection'
+require 'yammer/configurable'
+require 'yammer/response'
+require 'yammer/client'
+require 'yammer/identity_map'
+require 'yammer/model'
+require 'yammer/api'
+
+module Yammer
+  class << self
+    include Configurable
+
+    def client
+      @client = Yammer::Client.new
+    end
+
+  private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+  end
+end
+
+Yammer.reset!

data/lib/yammer/api.rb

@@ -0,0 +1,10 @@
+require 'yammer/api/user'
+require 'yammer/api/group'
+require 'yammer/api/group_membership'
+require 'yammer/api/message'
+require 'yammer/api/thread'
+require 'yammer/api/search'
+require 'yammer/api/topic'
+require 'yammer/api/autocomplete'
+require 'yammer/api/network'
+require 'yammer/api/notification'

data/lib/yammer/api/autocomplete.rb

@@ -0,0 +1,25 @@
+module Yammer
+  module Api
+    module Autocomplete
+
+      # @see https://developer.yammer.com/restapi/#rest-search
+      # @api_path /api/v1/autocomplete/ranked
+      # @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 [String] :prefix 
+      # @option opts [String] :models 
+      # @option opts [Integer] :network_id
+      # @option opts [Integer] :include_site_actions  
+      # @option opts [Boolean] :extended]               
+      # @option opts [Boolean] :include_network_domainss
+      # @example Fetch data for the thread
+      #   Yammer.search(:prefix => 'pizza', :models => 'user:3,group:8,topic:10')
+      def autocomplete(opts={})
+        get('/api/v1/autocomplete', opts)
+      end
+    end
+  end
+end