yamwow 0.0.4 → 0.0.5

data/lib/yamwow/client.rb

@@ -1,32 +1,32 @@
-require 'oauth'
-require 'json'
+require 'yam'
+require_relative 'throttle'
 
 module YamWow
   class Client
 
-    def initialize(oauth_credentials)
-      @oauth_credentials = oauth_credentials
+    def initialize(oauth_token)
+      @yam = Yam.new oauth_token, nil
+      @message_throttle = Throttle.new 10, 30
+      @autocomplete_throttle = Throttle.new 10, 10
     end
 
-    def get(url, throttle)
-      throttle.when_ready do
-        url = url.start_with?('http') ? url : File.join('https://www.yammer.com/api/v1', url)
-        puts "GET #{url}"
-        response = access_token.get url
-        JSON.parse response.body
-      end
+    def get_messages(path=nil, params={})
+      path = path ? File.join('messages', path) : 'messages.json'
+      get path, params, @message_throttle
     end
 
-    private
-
-    def access_token
-      @access_token ||= get_access_token
+    def get_autocomplete(params={})
+      get 'autocomplete.json', params, @autocomplete_throttle
     end
 
-    def get_access_token
-      o = @oauth_credentials
-      consumer = OAuth::Consumer.new o[:consumer_key], o[:consumer_secret], {:site => 'https://www.yammer.com', :scheme => :header}
-      OAuth::AccessToken.from_hash consumer, :oauth_token => o[:oauth_key], :oauth_token_secret => o[:oauth_secret]
+    private
+
+    def get(path, params, throttle)
+      path = '/' + path unless path.start_with? '/'
+      throttle.when_ready do
+        puts "GET #{path} #{params.inspect}"
+        @yam.get path, params
+      end
     end
 
   end

data/lib/yamwow/facade.rb

@@ -1,21 +1,33 @@
 module YamWow
   class Facade
 
-    def initialize(oauth_credentials)
-      @client = Client.new oauth_credentials
+    def initialize(oauth_token)
+      @client = Client.new oauth_token
     end
 
     def messages_for_topic(topic_name, options={})
-      request = MessagesByTopicRequest.new @client
-      response = request.send topic_name, options
+      request = MessagesForTopicRequest.new @client, topic_name, options
+      response = request.send
       response.messages
     end
 
     def praises(options={})
-      request = PraiseRequest.new @client
-      response = request.send options
+      request = PraiseRequest.new @client, options
+      response = request.send
       response.praises
     end
 
+    def topic(topic_name)
+      request = TopicRequest.new @client, topic_name
+      response = request.send
+      response.topic
+    end
+
+    def group(group_name)
+      request = GroupRequest.new @client, group_name
+      response = request.send
+      response.group
+    end
+
   end
 end

data/lib/yamwow/group.rb

@@ -0,0 +1,5 @@
+module YamWow
+  class Group
+    attr_accessor :id, :name
+  end
+end

data/lib/yamwow/group_request.rb

@@ -0,0 +1,47 @@
+require_relative 'group'
+require_relative 'group_response'
+
+module YamWow
+  class GroupRequest
+
+    def initialize(client, group_name)
+      @client = client
+      @group_name = group_name.gsub /[^0-9a-z]/i, ''
+    end
+
+    def send
+      group_data = get_group_data
+      group_data ? build_response(group_data) : build_empty_response
+    end
+
+    private
+
+    def get_group_data
+      data = send_autocomplete_request
+      topics = data['groups'] || []
+      topics.select { |t| t['name'].downcase == @group_name.downcase }[0]
+    end
+
+    def send_autocomplete_request
+      prefix = 'to:' + @group_name.downcase
+      @client.get_autocomplete prefix: prefix
+    end
+
+    def build_empty_response
+      GroupResponse.new nil
+    end
+
+    def build_response(group_data)
+      group = build_group group_data
+      GroupResponse.new group
+    end
+
+    def build_group(group_data)
+      g = YamWow::Group.new
+      g.id = group_data['id']
+      g.name = group_data['full_name']
+      g
+    end
+
+  end
+end

data/lib/yamwow/group_response.rb

@@ -0,0 +1,11 @@
+module YamWow
+  class GroupResponse
+
+    attr_reader :group
+
+    def initialize(group)
+      @group = group
+    end
+
+  end
+end

data/lib/yamwow/message.rb

@@ -3,73 +3,30 @@ require 'time'
 module YamWow
   class Message
 
-    def initialize(message_data, reference_data)
-      @message_data = message_data
-      @reference_data = reference_data
-    end
-
-    def id
-      @message_data['id']
-    end
+    attr_accessor :id, :plain_body, :parsed_body, :date_created, :like_count, :url, :sender, :reply_to_id, :attachments
 
     def sender_tag
-      "[[user:#{sender_id}]]"
+      "[[user:#{@sender.id}]]"
     end
 
     def sender_name
-      get_name sender_id
-    end
-
-    def plain_body
-      body['plain']
+      @sender.name
     end
 
     def plain_body_single_line
-      single_line plain_body
-    end
-
-    def parsed_body
-      body['parsed']
+      single_line @plain_body
     end
 
     def parsed_body_single_line
-      single_line parsed_body
-    end
-
-    def date_created
-      Time.parse @message_data['created_at']
-    end
-
-    def like_count
-      @message_data['liked_by']['count'].to_i
-    end
-
-    def url
-      @message_data['web_url']
-    end
-
-    def attachments
-      @message_data['attachments']
+      single_line @parsed_body
     end
 
     def thread_root?
-      @message_data.select { |m| m['replied_to_id'].nil? }
+      @reply_to_id.nil?
     end
 
     private
 
-    def sender_id
-      @message_data['sender_id']
-    end
-
-    def body
-      @message_data['body']
-    end
-
-    def get_name(id)
-      @reference_data.select { |r| r['id'] == id }[0]['full_name']
-    end
-
     def single_line(text)
       text.gsub("\n", ' ').strip
     end

data/lib/yamwow/messages_for_topic_request.rb

@@ -0,0 +1,99 @@
+require_relative 'topic_request'
+require_relative 'messages_for_topic_response'
+require_relative 'message'
+require_relative 'user'
+
+module YamWow
+  class MessagesForTopicRequest
+
+    def initialize(client, topic_name, options={})
+      @client = client
+      @topic_name = topic_name
+      @options = options
+    end
+
+
+    def send
+      @messages = []
+      loop_finished = false
+
+      until loop_finished
+        response_data = send_messages_request
+        before_message_count = @messages.length
+        add_messages response_data['messages'], response_data['references']
+        after_message_count = @messages.length
+        no_more_messages = before_message_count == after_message_count
+        loop_finished = no_more_messages || limit_reached
+      end
+
+      build_response
+    end
+
+    private
+
+    def send_messages_request
+      @client.get_messages "about_topic/#{topic_id}.json", threaded: true, older_than: oldest_message_id
+    end
+
+    def topic_id
+      @topic_id ||= get_topic_id
+    end
+
+    def get_topic_id
+      request = TopicRequest.new @client, @topic_name
+      response = request.send
+      raise "Topic '#{@topic_name}' was not found." unless response.topic
+      response.topic.id
+    end
+
+    def oldest_message_id
+      last_message = @messages.sort { |x, y| y.date_created <=> x.date_created }.last
+      last_message.id if last_message
+    end
+
+    def add_messages(messages_data, reference_data)
+      @messages += build_messages messages_data, reference_data
+      @messages = @messages[0..limit_count-1] if limit_count > 0
+    end
+
+    def build_messages(messages_data, reference_data)
+      messages_data.map { |m| build_message m, reference_data }.select { |m| m.thread_root? }
+    end
+
+    def build_message(message_data, reference_data)
+      d = message_data
+      m = Message.new
+      m.id = d['id']
+      m.plain_body = d['body']['plain']
+      m.parsed_body = d['body']['parsed']
+      m.date_created = Time.parse d['created_at']
+      m.like_count = d['liked_by']['count'].to_i
+      m.url = d['web_url']
+      m.sender = build_user d['sender_id'], reference_data
+      m.reply_to_id = d['replied_to_id']
+      m.attachments = d['attachments']
+      m
+    end
+
+    def build_user(user_id, reference_data)
+      d = reference_data.select { |r| r['id'] == user_id }[0]
+      u = User.new
+      u.id = d['id']
+      u.name = d['full_name']
+      u
+    end
+
+    def limit_reached
+      limit_count > 0 ? @messages.length == limit_count : false
+    end
+
+    def limit_count
+      @options[:limit_count] ? @options[:limit_count].to_i : 0
+    end
+
+    def build_response
+      MessagesForTopicResponse.new @messages
+    end
+
+  end
+end

data/lib/yamwow/messages_for_topic_response.rb

@@ -0,0 +1,11 @@
+module YamWow
+  class MessagesForTopicResponse
+
+    attr_reader :messages
+
+    def initialize(messages)
+      @messages = messages
+    end
+
+  end
+end

data/lib/yamwow/praise_request.rb

@@ -1,15 +1,16 @@
-require_relative 'messages_by_topic_request'
+require_relative 'messages_for_topic_request'
 
 module YamWow
   class PraiseRequest
 
-    def initialize(client)
+    def initialize(client, options={})
       @client = client
+      @options = options
     end
 
-    def send(options={})
-      messages_by_topic_request = MessagesByTopicRequest.new @client
-      messages_by_topic_response = messages_by_topic_request.send 'praise', options
+    def send
+      messages_by_topic_request = MessagesForTopicRequest.new @client, 'praise', @options
+      messages_by_topic_response = messages_by_topic_request.send
       PraiseResponse.new messages_by_topic_response.messages
     end
 

data/lib/yamwow/throttle.rb

@@ -1,13 +1,4 @@
 module YamWow
-
-  def self.message_throttle
-    @message_throttle ||= Throttle.new 10, 30
-  end
-
-  def self.autocomplete_throttle
-    @autocomplete_throttle ||= Throttle.new 10, 10
-  end
-
   class Throttle
 
     def initialize(max_requests, duration_in_seconds)

data/lib/yamwow/topic.rb

@@ -0,0 +1,5 @@
+module YamWow
+  class Topic
+    attr_accessor :id, :name
+  end
+end

data/lib/yamwow/topic_request.rb

@@ -1,18 +1,45 @@
+require_relative 'topic'
 require_relative 'topic_response'
-require_relative 'throttle'
 
 module YamWow
   class TopicRequest
 
-    def initialize(client)
+    def initialize(client, topic_name)
       @client = client
+      @topic_name = topic_name
     end
 
-    def send(topic_name)
-      response_data = @client.get "autocomplete.json?prefix=#{CGI::escape topic_name}", YamWow.autocomplete_throttle
-      topics = response_data['topics'] || []
-      matching_topic = topics.select { |t| t['name'].downcase == topic_name.downcase }[0]
-      matching_topic ? TopicResponse.new(matching_topic) : nil
+    def send
+      topic_data = get_topic_data
+      topic_data ? build_response(topic_data) : build_empty_response
+    end
+
+    private
+
+    def get_topic_data
+      data = send_autocomplete_request
+      topics = data['topics'] || []
+      topics.select { |t| t['name'].downcase == @topic_name.downcase }[0]
+    end
+
+    def send_autocomplete_request
+      @client.get_autocomplete prefix: @topic_name.downcase
+    end
+
+    def build_empty_response
+      TopicResponse.new nil
+    end
+
+    def build_response(topic_data)
+      topic = build_topic topic_data
+      TopicResponse.new topic
+    end
+
+    def build_topic(topic_data)
+      t = Topic.new
+      t.id = topic_data['id']
+      t.name = topic_data['name']
+      t
     end
 
   end

data/lib/yamwow/topic_response.rb

@@ -1,14 +1,10 @@
 module YamWow
   class TopicResponse
 
-    attr_reader :topic_data
+    attr_reader :topic
 
-    def initialize(topic_data)
-      @topic_data = topic_data
-    end
-
-    def topic_id
-      @topic_data['id']
+    def initialize(topic)
+      @topic = topic
     end
 
   end

data/lib/yamwow/user.rb

@@ -0,0 +1,5 @@
+module YamWow
+  class User
+    attr_accessor :id, :name
+  end
+end

data/lib/yamwow.rb

@@ -1 +1,2 @@
-Dir[File.expand_path(File.dirname(__FILE__) + '/yamwow/*.rb')].each { |f| require f }
+Dir[File.expand_path(File.dirname(__FILE__) + '/yamwow/*.rb')].each { |f| require f }
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yamwow
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-27 00:00:00.000000000 Z
+date: 2013-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: oauth
-  requirement: &70128193076360 !ruby/object:Gem::Requirement
+  name: yam
+  requirement: &70137642787560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70128193076360
+  version_requirements: *70137642787560
 description: 
 email: matthew-github@matthewriley.name
 executables: []
@@ -31,15 +31,20 @@ files:
 - lib/yamwow/client.rb
 - lib/yamwow/csv_generator.rb
 - lib/yamwow/facade.rb
+- lib/yamwow/group.rb
+- lib/yamwow/group_request.rb
+- lib/yamwow/group_response.rb
 - lib/yamwow/message.rb
-- lib/yamwow/messages_by_topic_request.rb
-- lib/yamwow/messages_by_topic_response.rb
+- lib/yamwow/messages_for_topic_request.rb
+- lib/yamwow/messages_for_topic_response.rb
 - lib/yamwow/praise.rb
 - lib/yamwow/praise_request.rb
 - lib/yamwow/praise_response.rb
 - lib/yamwow/throttle.rb
+- lib/yamwow/topic.rb
 - lib/yamwow/topic_request.rb
 - lib/yamwow/topic_response.rb
+- lib/yamwow/user.rb
 - lib/yamwow.rb
 homepage: http://rubygems.org/gems/yamwow
 licenses: []
@@ -64,5 +69,6 @@ rubyforge_project:
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Exploring the Yammer API.
+summary: YamWow is a Ruby Gem built on top of the Yammer REST API to provide useful,
+  higher level operations.
 test_files: []

data/lib/yamwow/messages_by_topic_request.rb

@@ -1,57 +0,0 @@
-require_relative 'topic_request'
-require_relative 'messages_by_topic_response'
-require_relative 'throttle'
-
-module YamWow
-  class MessagesByTopicRequest
-
-    def initialize(client)
-      @client = client
-    end
-
-    def send(topic_name, options={})
-      topic_id = get_topic_id topic_name
-      limit_count = (options[:limit_count] || 0).to_i
-
-      oldest_message_id = nil
-      reference_data = []
-      messages = []
-      limit_reached = false
-
-      loop do
-        response_data = get topic_id, oldest_message_id
-        reference_data += response_data['references']
-        message_data = response_data['messages']
-        messages += message_data.map { |m| Message.new m, reference_data }.select { |m| m.thread_root? }
-
-        if limit_count > 0
-          messages = messages[0..limit_count-1]
-          limit_reached = messages.length == limit_count
-        end
-
-        response = MessagesByTopicResponse.new messages
-        oldest_message_reached = response.oldest_message_id == oldest_message_id
-        loop_finished = oldest_message_reached || limit_reached
-        return response if loop_finished
-
-        oldest_message_id = response.oldest_message_id
-      end
-    end
-
-    private
-
-    def get_topic_id(topic_name)
-      request = TopicRequest.new @client
-      response = request.send topic_name
-      raise "Topic '#{topic_name}' was not found." unless response
-      response.topic_id
-    end
-
-    def get(topic_id, older_than=nil)
-      url = "messages/about_topic/#{topic_id}.json?threaded=true"
-      url += "&older_than=#{older_than}" if older_than
-      @client.get url, YamWow.message_throttle
-    end
-
-  end
-end

data/lib/yamwow/messages_by_topic_response.rb

@@ -1,16 +0,0 @@
-module YamWow
-  class MessagesByTopicResponse
-
-    attr_reader :messages
-
-    def initialize(messages)
-      @messages = messages
-    end
-
-    def oldest_message_id
-      last_message = messages.sort { |x, y| y.date_created <=> x.date_created }.last
-      last_message.id if last_message
-    end
-
-  end
-end