yam 1.1.0 → 2.0.0

data/lib/yammer/resources/user.rb

@@ -0,0 +1,67 @@
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+# Licensed under the Apache License, Version 2.0 (the "License"); 
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
+# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
+# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
+# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
+
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+module Yammer
+  module Resources
+    class User < Yammer::Resources::Base
+
+      # Returns authenticated user's details
+      # @!scope class
+      def self.current
+        result = api_handler.current_user
+        return nil unless result.success?
+        new(result.body)
+      end
+
+      # Creates a new user from email address
+      # @!scope class
+      def self.create(email)
+        result = api_handler.create_user(:email => email)
+        return nil unless result.created?
+        id = result.headers[:location].split('/').last.to_i
+        new(:id => id)
+      end
+
+      attr_accessor_deffered :first_name, :last_name, :full_name, :hire_date, :mugshot, :state,
+      :type, :admin, :verified_admin, :expertise, :birth_date, :stats, :show_ask_for_photo, :job_title,
+      :web_url, :url, :external_urls, :activated_at, :summary, :department, :previous_companies,
+      :follow_general_messages, :schools, :interests, :significant_other, :network_name, :network_id,
+      :can_broadcast, :web_preferences, :network_domains, :location, :contact, :kids_names, :guid,
+      :name, :mugshot_url, :mugshot_url_template, :settings, :timezone
+
+      # Returns user's primary email
+      def email
+        @email ||= begin
+          self.contact[:email_addresses].map do |e|
+            e[:address] if e[:type] == 'primary'
+          end.first
+        end
+      end
+
+      # Returns all users that this user is following
+      def following
+        api_handler.users_followed_by(@id)
+      end
+
+      # Returns all user's follwing this user
+      def followers
+        api_handler.users_following(@id)
+      end
+
+      # Updates the user attributes
+      def update!(params)
+        api_handler.update_user(@id, params)
+      end
+    end
+  end
+end

data/lib/yammer/{message_body.rb → resources.rb}

@@ -12,16 +12,11 @@
 # See the Apache Version 2.0 License for specific language governing
 # permissions and limitations under the License.
 
-module Yammer
-  class MessageBody
-    attr_reader :urls, :parsed, :rich
-    attr_accessor :plain
-
-    def initialize(opts={})
-      @plain  = opts.fetch(:plain,'')
-      @parsed = opts.fetch(:parsed,'')
-      @rich   = opts.fetch(:rich,'')
-      @urls   = opts.fetch(:urls,'')
-    end
-  end
-end
+require 'yammer/resources/identity_map'
+require 'yammer/resources/base'
+require 'yammer/resources/user'
+require 'yammer/resources/thread'
+require 'yammer/resources/message'
+require 'yammer/resources/message_body'
+require 'yammer/resources/group'
+require 'yammer/resources/group_membership'

data/lib/yammer/version.rb

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

data/lib/yammer.rb

@@ -20,13 +20,7 @@ require 'yammer/http_adapter'
 require 'yammer/client'
 require 'yammer/api_handler'
 require 'yammer/api_response'
-require 'yammer/identity_map'
-require 'yammer/base'
-require 'yammer/user'
-require 'yammer/group'
-require 'yammer/group_membership'
-require 'yammer/message'
-require 'yammer/thread'
+require 'yammer/resources'
 
 module Yammer
   class << self

data/spec/{model → resources}/base_spec.rb

@@ -19,9 +19,9 @@
 
 require File.expand_path('../../spec_helper', __FILE__)
 
-describe Yammer::Base do
+describe Yammer::Resources::Base do
 
-  class DummyModel < Yammer::Base
+  class DummyModel < Yammer::Resources::Base
     attr_accessor_deffered :first_name, :last_name
   end
 

data/spec/{model → resources}/group_membership_spec.rb

@@ -19,7 +19,7 @@
 
 require File.expand_path('../../spec_helper', __FILE__)
 
-describe Yammer::GroupMembership do
+describe Yammer::Resources::GroupMembership do
 
   before :all do
     Yammer.configure do |conf|
@@ -33,7 +33,7 @@ describe Yammer::GroupMembership do
 
   context 'class methods' do
 
-    subject { Yammer::GroupMembership }
+    subject { Yammer::Resources::GroupMembership }
 
     describe '#create_group_membership' do
       it 'creates a new group membership' do

data/spec/{model → resources}/group_spec.rb

@@ -19,7 +19,7 @@
 
 require File.expand_path('../../spec_helper', __FILE__)
 
-describe Yammer::Group do
+describe Yammer::Resources::Group do
   context 'class methods' do
 
     before :all do
@@ -32,7 +32,7 @@ describe Yammer::Group do
       Yammer.reset!
     end
 
-    subject { Yammer::Group }
+    subject { Yammer::Resources::Group }
 
     describe '#create' do
       it 'creates a new group' do

data/spec/{identity_map_spec.rb → resources/identity_map_spec.rb}

@@ -17,12 +17,12 @@
 # See the Apache Version 2.0 License for specific language governing
 # permissions and limitations under the License.
 
-require File.expand_path('../spec_helper', __FILE__)
-require 'yammer/identity_map'
+require File.expand_path('../../spec_helper', __FILE__)
+require 'yammer/resources/identity_map'
 
-describe Yammer::IdentityMap do
+describe Yammer::Resources::IdentityMap do
 
-  subject { Yammer::IdentityMap.new }
+  subject { Yammer::Resources::IdentityMap.new }
   
   after :each do
     subject.purge!
@@ -54,13 +54,13 @@ describe Yammer::IdentityMap do
     describe '#put' do
       context 'with nil key' do
         it 'should throw exception' do
-          expect { subject.put(nil, 'value') }.to raise_error(Yammer::IdentityMap::InvalidKeyError)
+          expect { subject.put(nil, 'value') }.to raise_error(Yammer::Resources::IdentityMap::InvalidKeyError)
         end
       end
 
       context 'with empty string' do
         it 'should throw exception' do
-          expect { subject.put('', 'value') }.to raise_error(Yammer::IdentityMap::InvalidKeyError)
+          expect { subject.put('', 'value') }.to raise_error(Yammer::Resources::IdentityMap::InvalidKeyError)
         end
       end
 

data/spec/{model → resources}/message_spec.rb

@@ -19,7 +19,7 @@
 
 require File.expand_path('../../spec_helper', __FILE__)
 
-describe Yammer::Message do
+describe Yammer::Resources::Message do
 
   before :all do
     Yammer.configure do |conf|
@@ -33,7 +33,7 @@ describe Yammer::Message do
 
   context 'class methods' do
 
-    subject { Yammer::Message }
+    subject { Yammer::Resources::Message }
 
     describe '#create' do
       it 'creates a new group' do

data/spec/{model → resources}/thread_spec.rb

@@ -19,7 +19,7 @@
 
 require File.expand_path('../../spec_helper', __FILE__)
 
-describe Yammer::Thread do
+describe Yammer::Resources::Thread do
 
   before :all do
     Yammer.configure do |conf|
@@ -31,10 +31,10 @@ describe Yammer::Thread do
     Yammer.reset!
   end
 
-  subject { Yammer::GroupMembership }
+  subject { Yammer::Resources::GroupMembership }
 
   context 'existing public thread' do
-    subject { Yammer::Thread.new(MultiJson.load(fixture("public_thread.json"), :symbolize_keys => true)) }
+    subject { Yammer::Resources::Thread.new(MultiJson.load(fixture("public_thread.json"), :symbolize_keys => true)) }
 
     describe "#id" do
       it 'returns id' do
@@ -44,14 +44,14 @@ describe Yammer::Thread do
 
     describe "#first_reply" do
       it 'returns first_reply' do
-        expect(subject.first_reply).to be_instance_of(Yammer::Message)
+        expect(subject.first_reply).to be_instance_of(Yammer::Resources::Message)
         expect(subject.first_reply.id).to eq 11
       end
     end
 
     describe "#last_reply" do
       it 'returns last_reply' do
-        expect(subject.last_reply).to be_instance_of(Yammer::Message)
+        expect(subject.last_reply).to be_instance_of(Yammer::Resources::Message)
         expect(subject.last_reply.id).to eq 13
       end
     end
@@ -79,11 +79,11 @@ describe Yammer::Thread do
   end
 
   context 'existing private thread' do
-    subject { Yammer::Thread.new(MultiJson.load(fixture("private_thread.json"), :symbolize_keys => true)) }
+    subject { Yammer::Resources::Thread.new(MultiJson.load(fixture("private_thread.json"), :symbolize_keys => true)) }
     describe "people" do
       it 'makes an http request and hydrates object' do
         subject.people.each do |person|
-          expect(person).to be_instance_of(Yammer::User)
+          expect(person).to be_instance_of(Yammer::Resources::User)
         end
       end
     end

data/spec/{model → resources}/user_spec.rb

@@ -19,7 +19,7 @@
 
 require File.expand_path('../../spec_helper', __FILE__)
 
-describe Yammer::User do
+describe Yammer::Resources::User do
 
   before :all do
     Yammer.configure do |conf|
@@ -33,7 +33,7 @@ describe Yammer::User do
 
   context 'class methods' do
 
-    subject { Yammer::User }
+    subject { Yammer::Resources::User }
 
     describe '#create' do
       it 'creates a new user' do
@@ -75,10 +75,10 @@ describe Yammer::User do
   context 'new user object with id' do
 
     before :each do
-      Yammer::User.identity_map.purge!
+      Yammer::Resources::User.identity_map.purge!
     end
 
-    subject { Yammer::User.new(:id => 1) }
+    subject { Yammer::Resources::User.new(:id => 1) }
 
     describe "#id" do
       it 'returns id' do
@@ -105,7 +105,7 @@ describe Yammer::User do
 
     describe "creating duplicate object" do
       it 'retrieves data from identitymap' do
-        user = Yammer::User.new(:id => 1)
+        user = Yammer::Resources::User.new(:id => 1)
         stub_request(:get, "https://www.yammer.com/api/v1/users/1").with(
           :headers => {
             'Accept'          => 'application/json',
@@ -119,14 +119,14 @@ describe Yammer::User do
         )
         expect(user.full_name).to eq 'John Smith'
 
-        duplicate = Yammer::User.new(:id => 1)
+        duplicate = Yammer::Resources::User.new(:id => 1)
         expect(duplicate.full_name).to eq 'John Smith'
       end
     end
   end
 
   context 'hydrated user object' do
-    subject { Yammer::User.new(MultiJson.load(fixture('user.json'), :symbolize_keys => true)) }
+    subject { Yammer::Resources::User.new(MultiJson.load(fixture('user.json'), :symbolize_keys => true)) }
 
     describe "#id" do
       it 'returns id' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yam
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Kevin Mutyaba
@@ -182,19 +182,20 @@ files:
 - lib/yammer/api/user.rb
 - lib/yammer/api_handler.rb
 - lib/yammer/api_response.rb
-- lib/yammer/base.rb
 - lib/yammer/client.rb
 - lib/yammer/configurable.rb
 - lib/yammer/error.rb
-- lib/yammer/group.rb
-- lib/yammer/group_membership.rb
 - lib/yammer/http_adapter.rb
-- lib/yammer/identity_map.rb
-- lib/yammer/message.rb
-- lib/yammer/message_body.rb
-- lib/yammer/pending_attachment.rb
-- lib/yammer/thread.rb
-- lib/yammer/user.rb
+- lib/yammer/resources.rb
+- lib/yammer/resources/base.rb
+- lib/yammer/resources/group.rb
+- lib/yammer/resources/group_membership.rb
+- lib/yammer/resources/identity_map.rb
+- lib/yammer/resources/message.rb
+- lib/yammer/resources/message_body.rb
+- lib/yammer/resources/pending_attachment.rb
+- lib/yammer/resources/thread.rb
+- lib/yammer/resources/user.rb
 - lib/yammer/version.rb
 - spec/api/activity_spec.rb
 - spec/api/autocomplete_spec.rb
@@ -225,14 +226,14 @@ files:
 - spec/fixtures/users_followed.json
 - spec/fixtures/users_following.json
 - spec/http_adapter_spec.rb
-- spec/identity_map_spec.rb
 - spec/mocks/attachment.txt
-- spec/model/base_spec.rb
-- spec/model/group_membership_spec.rb
-- spec/model/group_spec.rb
-- spec/model/message_spec.rb
-- spec/model/thread_spec.rb
-- spec/model/user_spec.rb
+- spec/resources/base_spec.rb
+- spec/resources/group_membership_spec.rb
+- spec/resources/group_spec.rb
+- spec/resources/identity_map_spec.rb
+- spec/resources/message_spec.rb
+- spec/resources/thread_spec.rb
+- spec/resources/user_spec.rb
 - spec/spec_helper.rb
 - yam.gemspec
 homepage: http://yammer.github.io/yam
@@ -289,12 +290,12 @@ test_files:
 - spec/fixtures/users_followed.json
 - spec/fixtures/users_following.json
 - spec/http_adapter_spec.rb
-- spec/identity_map_spec.rb
 - spec/mocks/attachment.txt
-- spec/model/base_spec.rb
-- spec/model/group_membership_spec.rb
-- spec/model/group_spec.rb
-- spec/model/message_spec.rb
-- spec/model/thread_spec.rb
-- spec/model/user_spec.rb
+- spec/resources/base_spec.rb
+- spec/resources/group_membership_spec.rb
+- spec/resources/group_spec.rb
+- spec/resources/identity_map_spec.rb
+- spec/resources/message_spec.rb
+- spec/resources/thread_spec.rb
+- spec/resources/user_spec.rb
 - spec/spec_helper.rb

data/lib/yammer/base.rb

@@ -1,208 +0,0 @@
-# Copyright (c) Microsoft Corporation
-# All rights reserved.
-# Licensed under the Apache License, Version 2.0 (the "License"); 
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 
-#
-# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
-# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
-# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
-# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
-
-# See the Apache Version 2.0 License for specific language governing
-# permissions and limitations under the License.
-
-module Yammer
-  class Base
-    class << self
-      include ApiHandler
-
-      # 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
-
-      # 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
-
-
-      # @!scope class
-      def fetch(id)
-        return unless identity_map
-        attributes = identity_map.get("#{base_name}_#{id}")
-        unless attributes
-          result = api_handler.send("get_#{base_name}", id)
-          attributes = result.empty? ? nil : result.body
-          unless attributes.empty?
-            identity_map.put("#{base_name}_#{id}", attributes)
-          end
-        end
-        attributes
-      end
-
-      # @!scope class
-      def 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 model_attributes
-        @model_attributes ||= {}
-      end
-
-    protected
-
-      def attr_accessor_deffered(*symbols)
-        symbols.each do |key|
-          # track attributes that should trigger a fetch
-          model_attributes[key] = false
-
-          # getter
-          define_method(key.to_s) do
-            load_deferred_attribute!(key)
-            instance_variable_get("@#{key}")
-          end
-
-          # 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
-    end
-
-    attr_reader :id, :attrs
-
-    def initialize(props={})
-      @klass               = self.class
-      @modified_attributes = {}
-      @new_record          = true
-      @loaded              = false
-      @attrs               = props
-      self.id              = @attrs.delete(:id)
-      self.update(@attrs)
-
-      yield self if block_given?
-    end
-
-    def api_handler
-      @klass.api_handler
-    end
-
-    def base_name
-      @klass.base_name
-    end
-
-    def new_record?
-      @new_record
-    end
-
-    def persisted?
-      !new_record?
-    end
-
-    def changes
-      @modified_attributes
-    end
-
-    def modified?
-      !changes.empty?
-    end
-
-    def loaded?
-      @loaded
-    end
-
-    def load!
-      @attrs = @klass.fetch(@id)
-      @loaded = true
-      update(@attrs)
-      self
-    end
-
-    def reload!
-      reset!
-      load!
-    end
-
-    def save
-      return self if ((persisted? && @modified_attributes.empty?) || @attrs.empty?)
-
-      result = if new_record?
-        api_handler.send("create_#{base_name}", @attrs)
-      else
-        api_handler.send("update_#{base_name}", @id, @modified_attributes)
-      end
-      @modified_attributes = {}
-      self
-    end
-
-    def delete!
-      return if new_record?
-      result = api_handler.send("delete_#{base_name}", @id)
-      result.success?
-    end
-
-  private
-
-    def id=(model_id)
-      return if model_id.nil?
-      @id = model_id.to_i
-      @new_record = false
-    end
-
-    # clear the entire class
-    def reset!
-      @modified_attributes = {}
-      @attrs  = {}
-      @new_record = true
-      @loaded = false
-    end
-
-  protected
-    # 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 = @klass.model_attributes.keys.inject(true) do |result, key|
-          result && @attrs.has_key?(key)
-        end
-      end
-    end
-  end
-end

data/lib/yammer/identity_map.rb

@@ -1,56 +0,0 @@
-# Copyright (c) Microsoft Corporation
-# All rights reserved.
-# Licensed under the Apache License, Version 2.0 (the "License"); 
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 
-#
-# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
-# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
-# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
-# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
-
-# See the Apache Version 2.0 License for specific language governing
-# permissions and limitations under the License.
-
-module Yammer
-  class IdentityMap
-
-    class InvalidKeyError < StandardError; end
-
-    def initialize
-      @map  = {}
-      @size = 0
-    end
-
-    # @note retrives key from identity map
-    # @return [Hash]
-    # @param key [string] 
-    # @param default [Hash]
-    def get(key, default=nil)
-      @map["#{key}"] || default
-    end
-
-    # @note inserts a hash of attributes into identity map
-    # @return [Hash]
-    # @param key [string] 
-    # @param value [Hash]
-    def put(key, value)
-      if key.nil? || key.empty?
-        raise InvalidKeyError.new
-      end
-      @map["#{key}"] = value
-    end
-
-    # @note returns the current size of identity map
-    # @return [Integer]
-    def size
-      @map.keys.count
-    end
-
-    # clears the entire identity map
-    # @return [Hash]
-    def purge!
-      @map = {}
-    end
-  end
-end