yamwow 0.0.2 → 0.0.3

data/lib/yamwow/{request_base.rb → client.rb}

@@ -2,20 +2,27 @@ require 'oauth'
 require 'json'
 
 module YamWow
-  class RequestBase
+  class Client
 
     def initialize(oauth_credentials)
       @oauth_credentials = oauth_credentials
     end
 
-    protected
+    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
+    end
+
+    private
 
     def access_token
       @access_token ||= get_access_token
     end
 
-    private
-
     def get_access_token
       o = @oauth_credentials
       consumer = OAuth::Consumer.new o[:consumer_key], o[:consumer_secret], {:site => 'https://www.yammer.com', :scheme => :header}

data/lib/yamwow/facade.rb

@@ -0,0 +1,21 @@
+module YamWow
+  class Facade
+
+    def initialize(oauth_credentials)
+      @client = Client.new oauth_credentials
+    end
+
+    def messages_for_topic(topic_name)
+      request = MessagesByTopicRequest.new @client
+      response = request.send topic_name
+      response.messages
+    end
+
+    def praises
+      request = PraiseRequest.new @client
+      response = request.send
+      response.praises
+    end
+
+  end
+end

data/lib/yamwow/message.rb

@@ -3,9 +3,13 @@ require 'time'
 module YamWow
   class Message
 
-    def initialize(response_data, references)
-      @response_data = response_data
-      @references = references
+    def initialize(message_data, reference_data)
+      @topic_data = message_data
+      @reference_data = reference_data
+    end
+
+    def id
+      @topic_data['id']
     end
 
     def sender_tag
@@ -17,41 +21,53 @@ module YamWow
     end
 
     def plain_body
-      @response_data['body']['plain']
+      body['plain']
+    end
+
+    def plain_body_single_line
+      single_line plain_body
     end
 
     def parsed_body
-      @response_data['body']['parsed']
+      body['parsed']
     end
 
     def parsed_body_single_line
-      parsed_body.gsub("\n", ' ').strip
+      single_line parsed_body
     end
 
     def date_created
-      Time.parse @response_data['created_at']
+      Time.parse @topic_data['created_at']
     end
 
     def like_count
-      @response_data['liked_by']['count'].to_i
+      @topic_data['liked_by']['count'].to_i
     end
 
     def url
-      @response_data['web_url']
+      @topic_data['web_url']
     end
 
     def attachments
-      @response_data['attachments']
+      @topic_data['attachments']
     end
 
     private
 
     def sender_id
-      @response_data['sender_id']
+      @topic_data['sender_id']
+    end
+
+    def body
+      @topic_data['body']
     end
 
     def get_name(id)
-      @references.select { |r| r['id'] == id }[0]['full_name']
+      @reference_data.select { |r| r['id'] == id }[0]['full_name']
+    end
+
+    def single_line(text)
+      text.gsub("\n", ' ').strip
     end
 
   end

data/lib/yamwow/messages_by_topic_request.rb

@@ -1,18 +1,45 @@
-require_relative 'request_base'
 require_relative 'topic_request'
 require_relative 'messages_by_topic_response'
+require_relative 'throttle'
 
 module YamWow
-  class MessagesByTopicRequest < RequestBase
+  class MessagesByTopicRequest
+
+    def initialize(client)
+      @client = client
+    end
 
     def send(topic_name)
-      topic_request = TopicRequest.new @oauth_credentials
-      topic_response = topic_request.send topic_name
-      raise "Topic '#{topic_name}' was not found." unless topic_response
-      response = access_token.get "https://www.yammer.com/api/v1/messages/about_topic/#{topic_response.topic_id}.json?threaded=true"
-      response_data = JSON.parse response.body
-      MessagesByTopicResponse.new response_data
+      topic_id = get_topic_id topic_name
+
+      oldest_message_id = nil
+      message_data = []
+      reference_data = []
+
+      loop do
+        response_data = get topic_id, oldest_message_id
+        message_data += response_data['messages']
+        reference_data += response_data['references']
+        response = MessagesByTopicResponse.new message_data, reference_data
+        return response if response.oldest_message_id == oldest_message_id
+        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
+end

data/lib/yamwow/messages_by_topic_response.rb

@@ -1,24 +1,26 @@
 module YamWow
   class MessagesByTopicResponse
 
-    attr_reader :response_data
+    attr_reader :message_data
 
-    def initialize(response_data)
-      @response_data = response_data
+    def initialize(message_data, reference_data)
+      @topic_data = message_data
+      @reference_data = reference_data
     end
 
     def messages
-      root_messages.map { |m| Message.new m, references }
+      @messages ||= root_messages.map { |m| Message.new m, @reference_data }
+    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
 
     private
 
     def root_messages
-      @response_data['messages'].select { |m| m['replied_to_id'].nil? }
-    end
-
-    def references
-      @response_data['references']
+      @topic_data.select { |m| m['replied_to_id'].nil? }
     end
 
   end

data/lib/yamwow/praise_request.rb

@@ -1,11 +1,14 @@
 require_relative 'messages_by_topic_request'
-require_relative 'praise_response'
 
 module YamWow
-  class PraiseRequest < RequestBase
+  class PraiseRequest
+
+    def initialize(client)
+      @client = client
+    end
 
     def send
-      messages_by_topic_request = MessagesByTopicRequest.new @oauth_credentials
+      messages_by_topic_request = MessagesByTopicRequest.new @client
       messages_by_topic_response = messages_by_topic_request.send 'praise'
       PraiseResponse.new messages_by_topic_response.messages
     end

data/lib/yamwow/praise_response.rb

@@ -8,36 +8,8 @@ module YamWow
     end
 
     def praises
-      @messages.map { |m| Praise.new m }
+      @praises ||= @messages.map { |m| Praise.new m }
     end
 
   end
-end
-
-#require_relative 'praise'
-#
-#module YamWow
-#  class PraiseResponse
-#
-#    attr_reader :response_data
-#
-#    def initialize(response_data)
-#      @response_data = response_data
-#    end
-#
-#    def praises
-#      root_messages.map { |m| Praise.new m, references }
-#    end
-#
-#    private
-#
-#    def root_messages
-#      @response_data['messages'].select { |m| m['replied_to_id'].nil? }
-#    end
-#
-#    def references
-#      @response_data['references']
-#    end
-#
-#  end
-#end
+end

data/lib/yamwow/throttle.rb

@@ -0,0 +1,46 @@
+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)
+      @request_log = []
+      @max_requests = max_requests
+      @duration_in_seconds = duration_in_seconds
+    end
+
+    def when_ready
+      sleep_if_limit_reached
+      @request_log << Time.now
+      yield
+    end
+
+    private
+
+    def sleep_if_limit_reached
+      seconds_to_sleep = calculate_seconds_to_sleep
+      return unless seconds_to_sleep > 0
+      puts "Rate limit reached. Sleeping for #{seconds_to_sleep} seconds..."
+      sleep seconds_to_sleep
+    end
+
+    def calculate_seconds_to_sleep
+      log_index = @request_log.length - @max_requests
+      return 0 if log_index < 0
+
+      oldest_applicable = @request_log[log_index]
+      return 0 unless oldest_applicable
+
+      age = Time.now - oldest_applicable
+      (@duration_in_seconds - age).ceil
+    end
+
+  end
+end

data/lib/yamwow/topic_request.rb

@@ -1,12 +1,15 @@
-require_relative 'request_base'
 require_relative 'topic_response'
+require_relative 'throttle'
 
 module YamWow
-  class TopicRequest < RequestBase
+  class TopicRequest
+
+    def initialize(client)
+      @client = client
+    end
 
     def send(topic_name)
-      response = access_token.get "https://www.yammer.com/api/v1/autocomplete.json?prefix=#{topic_name}"
-      response_data = JSON.parse response.body
+      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

data/lib/yamwow/topic_response.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yamwow
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70299510551020 !ruby/object:Gem::Requirement
+  requirement: &70183684306860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,23 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70299510551020
+  version_requirements: *70183684306860
 description: 
 email: matthew-github@matthewriley.name
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/yamwow/client.rb
 - lib/yamwow/csv_generator.rb
+- lib/yamwow/facade.rb
 - lib/yamwow/message.rb
 - lib/yamwow/messages_by_topic_request.rb
 - lib/yamwow/messages_by_topic_response.rb
 - lib/yamwow/praise.rb
 - lib/yamwow/praise_request.rb
 - lib/yamwow/praise_response.rb
-- lib/yamwow/request_base.rb
+- lib/yamwow/throttle.rb
 - lib/yamwow/topic_request.rb
 - lib/yamwow/topic_response.rb
 - lib/yamwow.rb