yammer-client 0.1.1 → 0.1.2

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    yammer-client (0.1.2)
+      addressable (~> 2.3.3)
+      multi_json (~> 1.3)
+      oauth2-client (~> 1.1.2)
+      oj (~> 2.0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.3)
+    bcrypt-ruby (3.0.1)
+    colorize (0.5.8)
+    coveralls (0.6.0)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    crack (0.3.2)
+    diff-lcs (1.2.1)
+    json (1.7.5)
+    mime-types (1.21)
+    multi_json (1.6.1)
+    oauth2-client (1.1.2)
+      addressable
+      bcrypt-ruby (~> 3.0.0)
+    oj (2.0.10)
+    rake (10.0.3)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.17.0)
+    webmock (1.10.1)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  json
+  rake
+  rspec (>= 2.11)
+  simplecov
+  webmock (>= 1.10.1)
+  yammer-client!

data/README.md

@@ -14,9 +14,11 @@ A Yammer Ruby gem
 
 ## Documentation
 
+This README provides only a basic overview of how to use this gem.For more information about the API endpoints and helper methods available, look at the rdoc documentation.
+
 [http://rdoc.info/github/tiabas/yammer-client][documentation]
 
-[documentation]: http://rdoc.info/github/tiabas/yammer-client 
+[documentation]: http://rdoc.info/github/tiabas/yammer-client/index 
 
 
 ## Installation
@@ -41,19 +43,11 @@ $ 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>
-
+The Yammer API requires authentication for access to certain endpoints. Below are the basic steps to get this done.
 
 ### 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 
-
+Setup a Yammer client application as described in [Build your first Yammer App](https://developer.yammer.com/introduction/)
 
 ### Obtaining an access token
 
@@ -197,15 +191,14 @@ yamr.search(:search => 'thekev', :model_types => 'users;groups')
 *fetch a thread with a given id*
 
 ```ruby
-yamr.get_thread(42, :model_types => 'users;groups')
+yamr.get_thread(42)
 #<Yammer::Response:0x007fb949434ec8 @headers=#<Net::HTTPOK 200 OK readbody=true>, @body="[JSON Response]", @code=200>
 ```
 
 
-### Using the object models
+### Using the object models (Experimental)
 
-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. 
+The object model is an abstraction that makes it easy to manipulate the JSON data return when accessing Yammer's API. Each model has accessor methods for all keys contained in the JSON response for a given model type. 
 
 
 **User**
@@ -230,26 +223,28 @@ u.update!(:job_title => 'k0dR')
 
 ```ruby
 t = Yammer::Thread.get(3)
+```
 
-# view the participants in the thread
+View the participants in the thread
 
+```ruby
 parts = t.participants
 #> [{:type=>"user", :id=>18}, {:type=>"user", :id=>64}]
+```
 
+View the participants in the thread as user object models
 
-# view the participants in the thread as user object models
-
+```ruby
 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. Calling an accessor on a model will hydrate it
 
-# object models are lazyly loaded
-
+```ruby
 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'
 

data/lib/yammer/base.rb

@@ -1,77 +1,93 @@
 module Yammer
   class Base
+    class << self
+
+      # Returns the non-qualified class name
+      # @!scope class
+      def base_name
+        @base_name ||= begin
+          word = "#{name.split(/::/).last}"
+          word.gsub!(/::/, '/')
+          word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+          word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+          word.tr!("-", "_")
+          word.downcase!
+          word
+        end
+      end
 
-    def self.attr_accessor_deffered(*symbols)
-      symbols.each do |key|
-        fetchable_keys[key] = true
+      # Fetches JSON reprsentation for object model with provided `id`
+      # and returns a model instance with attributes
+      # @return [Yammer::Base]
+      # @param id [Integer]
+      # @!scope class
+      def get(id)
+        attrs = fetch(id)
+        attrs ? new(attrs) : nil
+      end
 
-        define_method (key.to_s) do
-          if self.class.fetchable_keys.has_key?(key) && !@attrs.has_key?(key) && @id
-            load!
-          end
-          instance_variable_get("@#{key}")
-        end
 
-        define_method ("#{key}=") do |value|
-          if @attrs.fetch(key, false) && !new_record?
-            @modified_attributes[key] = value
-          else
-            @attrs[key] = value
+      # @!scope class
+      def fetch(id)
+        return unless identity_map
+        attributes = identity_map.get("#{base_name}_#{id}")
+        unless attributes
+          result = Yammer.send("get_#{base_name}", id)
+          attributes = result.empty? ? nil : result.body
+          unless attributes.empty?
+            identity_map.put("#{base_name}_#{id}", attributes)
           end
-          instance_variable_set("@#{key}", value)
         end
+        attributes
       end
-    end
 
-    # @!scope class
-    def self.fetchable_keys
-      @fetchable_keys ||= {}
-      return @fetchable_keys
-    end
+      # @!scope class
+      def identity_map
+        @identity_map ||= Yammer::IdentityMap.new
+      end
 
-    # @!scope class
-    def self.identity_map
-      @identity_map ||= Yammer::IdentityMap.new
-    end
+      # Returns a hash of all attributes that are meant to trigger an HTTP request 
+      # @!scope class
+      def fetchable_attrs
+        @fetchable_keys ||= {}
+      end
 
-    # @!scope class
-    def self.base_name
-      word = "#{self.name.split(/::/).last}"
-      word.gsub!(/::/, '/')
-      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-      word.tr!("-", "_")
-      word.downcase!
-      word
-    end
+    protected
+
+      def attr_accessor_deffered(*symbols)
+        symbols.each do |key|
+          # track attributes the trigger fetch
+          fetchable_attrs[key] = false
+
+          # getter
+          define_method(key.to_s) do
+            load_deferred_attribute!(key)
+            instance_variable_get("@#{key}")
+          end
 
-    # @!scope class
-    def self.fetch(id)
-      return unless identity_map
-      attributes = identity_map.get("#{self.base_name}_#{id}")
-      unless attributes
-        result = Yammer.send("get_#{self.base_name}", id)
-        attributes = result.body || {}
-        unless attributes.empty?
-          identity_map.put("#{self.base_name}_#{id}", attributes)
+          # setter
+          define_method("#{key}=") do |value|
+            load_deferred_attribute!(key)
+            if persisted? && loaded?
+              @modified_attributes[key] = value
+            else
+              @attrs[key] = value
+            end
+            instance_variable_set("@#{key}", value)
+          end
         end
       end
-      attributes
-    end
-
-    # @!scope class
-    def self.get(id)
-      new(fetch(id))
     end
 
     attr_reader :id, :attrs
 
     def initialize(props={})
       @modified_attributes = {}
-      @attrs               = {}
-      @new_record          =  true
-      self.id              = props.delete(:id)
-      self.update(props)
+      @new_record          = true
+      @loaded              = false
+      @attrs               = props
+      self.id              = @attrs.delete(:id)
+      self.update(@attrs)
     end
 
     def base_name
@@ -82,6 +98,10 @@ module Yammer
       @new_record
     end
 
+    def persisted?
+      !new_record?
+    end
+
     def changes
       @modified_attributes
     end
@@ -90,18 +110,29 @@ module Yammer
       !changes.empty?
     end
 
+    def loaded?
+      @loaded
+    end
+
     def load!
-      result = self.class.fetch(@id)
-      update(result)
+      @attrs = self.class.fetch(@id)
+      @loaded = true
+      update(@attrs)
+      self
+    end
+
+    def reload!
+      reset!
+      load!
     end
-    alias_method :reload!, :load!
 
     def save
-      return self if ((!new_record? && @modified_attributes.empty?) || @attrs.empty?)
+      return self if ((persisted? && @modified_attributes.empty?) || @attrs.empty?)
+
       result = if new_record?
-        Yammer.send("create_#{self.base_name}", @attrs)
+        Yammer.send("create_#{base_name}", @attrs)
       else
-        Yammer.send("update_#{self.base_name}", @id, @modified_attributes)
+        Yammer.send("update_#{base_name}", @id, @modified_attributes)
       end
       @modified_attributes = {}
       self
@@ -109,7 +140,7 @@ module Yammer
 
     def delete!
       return if new_record?
-      result = Yammer.send("delete_#{self.base_name}", @id)
+      result = Yammer.send("delete_#{base_name}", @id)
       result.success?
     end
 
@@ -121,11 +152,35 @@ module Yammer
       @new_record = false
     end
 
+    # clear the entire class
+    def reset!
+      @modified_attributes = {}
+      @attrs  = {}
+      @new_record = true
+      @loaded = false
+    end
+
   protected
-    def update(props={})
-      props.each do |key, value|
+    # loads model 
+    def load_deferred_attribute!(key)
+      if @attrs.empty? && persisted? && !loaded?
+        load!
+        if !@attrs.has_key?(key)
+          raise "The key: #{key} appears not to be supported for model: #{self.base_name} \n #{@attrs.keys.inspect}"
+        end
+      end
+    end
+
+    # set all fetchable attributes 
+    def update(attrs={})
+      attrs.each do |key, value|
         send("#{key}=", value)
       end
+      if persisted? && !loaded?
+        @loaded = self.class.fetchable_attrs.keys.inject(true) do |result, key|
+          result && @attrs.has_key?(key)
+        end
+      end
     end
   end
 end

data/lib/yammer/client.rb

@@ -15,7 +15,7 @@ module Yammer
     include Yammer::Api::Network
     include Yammer::Api::Search
     include Yammer::Api::Notification
-    include Yammer::Api::Autocomplete    
+    include Yammer::Api::Autocomplete
 
     attr_writer :connection_options
     attr_accessor :site_url, :http_adapter
@@ -66,19 +66,19 @@ module Yammer
 
     # Makes an HTTP request using the provided parameters
     # @raise [Yammer::Error::Unauthorized]
-    # @param method [string]  
+    # @param method [string]
     # @param path [string]
     # @param params [Hash]
     # @param opts [Hash]
     # @return [Yammer::Response]
     # @!visibility private
     def request(method, path, params={}, opts={})
-      # Log request here
+      headers  = opts.fetch(:headers, {}).merge({
+        'Authorization' => "Bearer #{@access_token}"
+      })
       response = connection.send_request(method, path, {
         :params  => params,
-        :headers => {
-          'Authorization' => "Bearer #{@access_token}"
-        }
+        :headers => headers
       })
       result = Yammer::Response.new(response)
       status = result.code

data/lib/yammer/version.rb

@@ -2,7 +2,7 @@ module Yammer
   class Version
     MAJOR = 0 unless defined? Yammer::MAJOR
     MINOR = 1 unless defined? Yammer::MINOR
-    PATCH = 1 unless defined? Yammer::PATCH
+    PATCH = 2 unless defined? Yammer::PATCH
     PRE = nil unless defined? Yammer::PRE
 
     class << self

data/spec/connection_spec.rb

@@ -37,7 +37,7 @@ describe Yammer::HttpConnection do
   describe "#default_headers" do
     it "returns user_agent and response format" do
       expect(subject.default_headers).to eq ({
-        "Accept"     => "application/json", 
+        "Accept"     => "application/json",
         "User-Agent" => "Yammer Ruby Gem #{Yammer::Version}"
       })
     end
@@ -172,10 +172,14 @@ describe Yammer::HttpConnection do
         path = '/oauth/authorize'
         params = {:client_id => '001337', :client_secret => 'abcxyz'}
         method = :get
-        
+
         normalized_path = '/oauth/authorize?client_id=001337&client_secret=abcxyz'
 
-        Net::HTTP.any_instance.should_receive(:get).with(normalized_path, subject.default_headers).and_return(@http_ok)
+        stub_request(:get, "https://yammer.com/oauth/authorize?client_id=001337&client_secret=abcxyz").with(
+          :headers => {
+            'Accept'=>'application/json',
+            'User-Agent'=>"Yammer Ruby Gem #{Yammer::Version}"
+        })
         response = subject.send_request(method, path, :params => params)
 
         expect(response.code).to eq '200'
@@ -187,9 +191,13 @@ describe Yammer::HttpConnection do
         path = '/users/1'
         method = 'delete'
 
-        Net::HTTP.any_instance.should_receive(:delete).with(path, subject.default_headers).and_return(@http_ok)
-        response = subject.send_request(method, path)
+        stub_request(:delete, "https://yammer.com/users/1").with(
+          :headers => {
+            'Accept'=>'application/json',
+            'User-Agent'=>"Yammer Ruby Gem #{Yammer::Version}"
+          }).to_return(:status => 200, :body => "", :headers => {})
 
+        response = subject.send_request(method, path)
         expect(response.code).to eq '200'
       end
     end
@@ -201,9 +209,18 @@ describe Yammer::HttpConnection do
         query  = Addressable::URI.form_encode(params)
         headers = {'Content-Type' => 'application/x-www-form-urlencoded' }.merge(subject.default_headers)
 
-        Net::HTTP.any_instance.should_receive(:post).with(path, query, headers).and_return(@http_ok)
-        response =subject.send_request(:post, path, :params => params)
+        stub_request(:post, "https://yammer.com/users").with(
+          :body => {
+            "first_name"=>"john",
+            "last_name"=>"smith"
+            },
+          :headers => {
+            'Accept'=>'application/json',
+            'Content-Type'=>'application/x-www-form-urlencoded',
+            'User-Agent'=>"Yammer Ruby Gem #{Yammer::Version}"
+        }).to_return(:status => 200, :body => "", :headers => {})
 
+        response =subject.send_request(:post, path, :params => params)
         expect(response.code).to eq '200'
       end
     end
@@ -215,10 +232,19 @@ describe Yammer::HttpConnection do
         query  = Addressable::URI.form_encode(params)
         headers = {'Content-Type' => 'application/x-www-form-urlencoded' }.merge(subject.default_headers)
 
-        Net::HTTP.any_instance.should_receive(:put).with(path, query, headers).and_return(@http_ok)
+        stub_request(:put, "https://yammer.com/users/1").with(
+          :body => {
+            "first_name" => "jane",
+            "last_name"  => "doe"
+          },
+          :headers => {
+            'Accept'=>'application/json',
+            'Content-Type'=>'application/x-www-form-urlencoded',
+            'User-Agent'=>"Yammer Ruby Gem #{Yammer::Version}"
+          }).
+         to_return(:status => 200, :body => "", :headers => {})
 
         response = subject.send_request(:put, path, :params => params)
-
         expect(response.code).to eq '200'
       end
     end

data/spec/model/base_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path('../../spec_helper', __FILE__)
 
 describe Yammer::Base do
   class DummyModel < Yammer::Base
-    attr_accessor_deffered :first_name, :last_name  
+    attr_accessor_deffered :first_name, :last_name
   end
 
   class Yammer::Client
@@ -123,7 +123,7 @@ describe Yammer::Base do
             :last_name => 'smith')
           ).and_return(double('Response', :success? => true, :created? => true, :body => {:id => 2}))
           subject.first_name = 'john'
-          subject.last_name = 'smith' 
+          subject.last_name = 'smith'
           subject.save
         end
       end
@@ -143,9 +143,10 @@ describe Yammer::Base do
         subject { DummyModel.new(:first_name => 'jim', :last_name => 'peters') }
 
         it 'should create model' do
-          Yammer.should_receive(:create_dummy_model).with(
-            hash_including(:first_name =>'john', :last_name => 'peters')
-          ).and_return(double('Response', :success? => true, :created? => true, :body => {:id => 2}))
+          Yammer.should_receive(:create_dummy_model).with({
+            :first_name =>'john',
+            :last_name => 'peters'
+          }).and_return(double('Response', :success? => true, :created? => true, :body => {:id => 2}))
           subject.first_name = 'john'
           subject.save
         end

data/spec/model/user_spec.rb

@@ -85,7 +85,7 @@ describe Yammer::User do
     end
   end
 
-  context 'hygrated user object' do
+  context 'hydrated user object' do
     subject { Yammer::User.new(MultiJson.load(fixture('user.json'), :symbolize_keys => true)) }
 
     describe "#id" do

data/yammer.gemspec

@@ -5,7 +5,7 @@ require 'yammer/version'
 Gem::Specification.new do |s|
   s.name             = 'yammer-client'
   s.version          = Yammer::Version
-  s.date             = %q{2013-04-08}
+  s.date             = %q{2013-04-09}
   s.summary          = "Yammer API Client - beta"
   s.description      = "A Ruby wrapper for accessing Yammer's REST API"
   s.authors          = ["Kevin Mutyaba"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yammer-client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -38,7 +38,7 @@ cert_chain:
   OGZyVURBOQpqNmZBVGcvNGZxcGdJTFBWcUZJR1pPTUpERmNKeS9vZWh3d3hM
   dTVYTXg4OFdGRDlqVDF2Umo3N0Q3aVBMYlhkCnJmR3MvcUNKS2dpZlhkLzFh
   bTVobEFINWpYVT0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQo=
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -179,6 +179,7 @@ files:
 - .yardopts
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile