yamwow 0.0.10 → 0.0.11

data/lib/yamwow/client.rb

@@ -8,6 +8,7 @@ module YamWow
       @yam = Yam.new oauth_token, nil
       @message_throttle = Throttle.new 10, 30
       @autocomplete_throttle = Throttle.new 10, 10
+      @other_throttle = Throttle.new 10, 10
     end
 
     def get_messages(path=nil, params={})
@@ -19,6 +20,10 @@ module YamWow
       get 'autocomplete.json', params, @autocomplete_throttle
     end
 
+    def get_other(path, params={})
+      get path, params, @other_throttle
+    end
+
     private
 
     def get(path, params, throttle)

data/lib/yamwow/enumerable_extensions.rb

@@ -0,0 +1,25 @@
+module Enumerable
+
+  def flatten_with_path(parent_prefix = nil)
+    res = {}
+
+    self.each_with_index do |elem, i|
+      if elem.is_a?(Array)
+        k, v = elem
+      else
+        k, v = i, elem
+      end
+
+      key = parent_prefix ? "#{parent_prefix}.#{k}" : k # assign key name for result hash
+
+      if v.is_a? Enumerable
+        res.merge!(v.flatten_with_path(key)) # recursive call to flatten child elements
+      else
+        res[key] = v
+      end
+    end
+
+    res
+  end
+
+end

data/lib/yamwow/facade.rb

@@ -1,6 +1,5 @@
 require_relative 'client'
-Dir[File.expand_path(File.dirname(__FILE__) + '/*_request.rb')].each { |f| require f }
-require_relative 'message_builder'
+require_relative 'requests'
 
 module YamWow
   class Facade
@@ -10,21 +9,19 @@ module YamWow
     end
 
     def messages_with_topic(topic_name, options={})
-      r = MessagesWithTopicRequest.new(@client, topic_name, options).send
-      b = MessageBuilder.new
-      r['messages'].map { |m| b.build_message m, r['references'] }
+      MessagesWithTopicRequest.new(@client, topic_name, options).send
     end
 
     def praises(options={})
       PraiseRequest.new(@client, options).send
     end
 
-    def topic_with_name(topic_name)
-      TopicWithNameRequest.new(@client, topic_name).send
+    def topic_with_name(topic_name, options={})
+      TopicWithNameRequest.new(@client, topic_name, options).send
     end
 
-    def topics
-      TopicsRequest.new(@client).send
+    def topics(options={})
+      TopicsRequest.new(@client, options).send
     end
 
     def group_with_name(group_name)

data/lib/yamwow/requests/group_with_name_request.rb

@@ -0,0 +1,29 @@
+require_relative '../response'
+
+module YamWow
+  class GroupWithNameRequest
+
+    def initialize(client, group_name)
+      @client = client
+      @group_name = group_name.downcase.gsub(/[^0-9a-z]/i, '')
+    end
+
+    def send
+      groups = get_groups
+      group = first_group_with_matching_name groups
+      Response.new group
+    end
+
+    private
+
+    def get_groups
+      r = @client.get_autocomplete prefix: 'to:' + @group_name
+      r['groups'] || []
+    end
+
+    def first_group_with_matching_name(groups)
+      groups.select { |g| g['name'] == @group_name }.first
+    end
+
+  end
+end

data/lib/yamwow/{messages_with_topic_request.rb → requests/messages_with_topic_request.rb}

@@ -1,6 +1,6 @@
+require 'time'
+require_relative '../response'
 require_relative 'topic_with_name_request'
-require_relative 'message'
-require_relative 'user'
 
 module YamWow
   class MessagesWithTopicRequest
@@ -27,10 +27,7 @@ module YamWow
 
       @messages.sort! { |x, y| Time.parse(y['created_at']) <=> Time.parse(x['created_at']) }
 
-      {
-        'messages' => @messages,
-        'references' => @references
-      }
+      Response.new @messages, @references
     end
 
     private
@@ -45,7 +42,8 @@ module YamWow
 
     def get_topic_id
       request = TopicWithNameRequest.new @client, @topic_name
-      topic = request.send
+      response = request.send
+      topic = response.data
       raise "Topic '#{@topic_name}' was not found." unless topic
       topic.id
     end

data/lib/yamwow/{praise_request.rb → requests/praise_request.rb}

@@ -1,5 +1,4 @@
 require_relative 'messages_with_topic_request'
-require_relative 'praise'
 
 module YamWow
   class PraiseRequest
@@ -10,9 +9,11 @@ module YamWow
     end
 
     def send
-      r = MessagesWithTopicRequest.new @client, 'praise', @options
-      messages = r.send
-      messages.map { |m| Praise.new m }
+      get_messages_with_praise_topic
+    end
+
+    def get_messages_with_praise_topic
+      MessagesWithTopicRequest.new(@client, 'praise', @options).send
     end
 
   end

data/lib/yamwow/requests/topic_with_id_request.rb

@@ -0,0 +1,17 @@
+require_relative '../response'
+
+module YamWow
+  class TopicWithIdRequest
+
+    def initialize(client, topic_id)
+      @client = client
+      @topic_id = topic_id
+    end
+
+    def send
+      topic = @client.get_other "topics/#{@topic_id}.json"
+      Response.new topic
+    end
+
+  end
+end

data/lib/yamwow/requests/topic_with_name_request.rb

@@ -0,0 +1,31 @@
+require_relative '../response'
+require_relative 'topics_with_prefix_request'
+
+module YamWow
+  class TopicWithNameRequest
+
+    def initialize(client, topic_name, options={})
+      @client = client
+      @topic_name = topic_name
+      @detailed = options[:detailed]
+    end
+
+    def send
+      topics = get_topics
+      topic = first_topic_with_matching_name topics
+      Response.new topic
+    end
+
+    private
+
+    def get_topics
+      response = TopicsWithPrefixRequest.new(@client, @topic_name, detailed: @detailed).send
+      response.data || []
+    end
+
+    def first_topic_with_matching_name(topics)
+      topics.select { |t| t['name'].casecmp(@topic_name) == 0 }.first
+    end
+
+  end
+end

data/lib/yamwow/requests/topics_request.rb

@@ -0,0 +1,37 @@
+require_relative '../response'
+require_relative 'topics_with_prefix_request'
+
+module YamWow
+  class TopicsRequest
+
+    def initialize(client, options={})
+      @client = client
+      @detailed = options[:detailed]
+    end
+
+    def send
+      @topics = []
+      process_range '0', '9'
+      process_range 'a', 'z'
+      @topics.uniq! { |t| t['id'] }
+      @topics.sort! { |x, y| x['name'].downcase <=> y['name'].downcase }
+      Response.new @topics
+    end
+
+    private
+
+    def process_range(first, last, current=nil)
+      ((current.to_s + first)..(current.to_s + last)).each do |prefix|
+        topics = send_topics_with_prefix_request prefix
+        @topics += topics
+        process_range first, last, prefix if topics.length == 50
+      end
+    end
+
+    def send_topics_with_prefix_request(topic_prefix)
+      response = TopicsWithPrefixRequest.new(@client, topic_prefix, detailed: @detailed).send
+      response.data || []
+    end
+
+  end
+end

data/lib/yamwow/requests/topics_with_prefix_request.rb

@@ -0,0 +1,36 @@
+require_relative '../response'
+require_relative 'topic_with_id_request'
+
+module YamWow
+  class TopicsWithPrefixRequest
+
+    def initialize(client, topic_prefix, options={})
+      @client = client
+      @topic_prefix = topic_prefix
+      @detailed = options[:detailed]
+    end
+
+    def send
+      topics = get_topics
+      topics.each { |t| add_details t } if @detailed
+      Response.new topics
+    end
+
+    private
+
+    def get_topics
+      response = @client.get_autocomplete(prefix: @topic_prefix)
+      response['topics'] || []
+    end
+
+    def add_details(topic)
+      detailed_topic = get_detailed_topic topic['id']
+      topic.merge! detailed_topic
+    end
+
+    def get_detailed_topic(topic_id)
+      TopicWithIdRequest.new(@client, topic_id).send
+    end
+
+  end
+end

data/lib/yamwow/requests.rb

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

data/lib/yamwow/response.rb

@@ -0,0 +1,35 @@
+require 'csv'
+require_relative 'enumerable_extensions'
+
+module YamWow
+  class Response
+
+    attr_accessor :data, :reference_data
+
+    def initialize(data, reference_data=nil)
+      @data = data
+      @reference_data = reference_data
+    end
+
+    def to_csv(options={})
+      data = @data.kind_of?(Array) ? @data : [@data]
+      hashes = data.map { |h| h.flatten_with_path }
+      columns = options[:include]
+
+      unless columns
+        keys = Set.new
+        hashes.each { |h| keys += h.keys }
+        columns = keys.sort
+      end
+
+      exclude_columns = options[:exclude] || []
+      columns = columns.reject { |c1| exclude_columns.index { |c2| c1 =~ c2 } }
+
+      CSV.generate do |csv|
+        csv << columns
+        hashes.each { |h| csv << columns.map { |k| h[k] } }
+      end
+    end
+
+  end
+end

data/lib/yamwow.rb

@@ -1,3 +1,2 @@
 ENV['SSL_CERT_FILE'] ||= File.expand_path(File.dirname(__FILE__) + '/cacert.pem')
-require_relative 'yamwow/facade'
-require_relative 'yamwow/csv_generator'
+require_relative 'yamwow/facade'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yamwow
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-06 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yam
-  requirement: &70150410097100 !ruby/object:Gem::Requirement
+  requirement: &70345739143900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70150410097100
+  version_requirements: *70345739143900
 description: 
 email: matthew-github@matthewriley.name
 executables: []
@@ -30,20 +30,18 @@ extra_rdoc_files: []
 files:
 - lib/cacert.pem
 - lib/yamwow/client.rb
-- lib/yamwow/csv_generator.rb
+- lib/yamwow/enumerable_extensions.rb
 - lib/yamwow/facade.rb
-- lib/yamwow/group.rb
-- lib/yamwow/group_with_name_request.rb
-- lib/yamwow/message.rb
-- lib/yamwow/message_builder.rb
-- lib/yamwow/messages_with_topic_request.rb
-- lib/yamwow/praise.rb
-- lib/yamwow/praise_request.rb
+- lib/yamwow/requests/group_with_name_request.rb
+- lib/yamwow/requests/messages_with_topic_request.rb
+- lib/yamwow/requests/praise_request.rb
+- lib/yamwow/requests/topic_with_id_request.rb
+- lib/yamwow/requests/topic_with_name_request.rb
+- lib/yamwow/requests/topics_request.rb
+- lib/yamwow/requests/topics_with_prefix_request.rb
+- lib/yamwow/requests.rb
+- lib/yamwow/response.rb
 - lib/yamwow/throttle.rb
-- lib/yamwow/topic.rb
-- lib/yamwow/topic_with_name_request.rb
-- lib/yamwow/topics_request.rb
-- lib/yamwow/user.rb
 - lib/yamwow.rb
 homepage: http://rubygems.org/gems/yamwow
 licenses: []

data/lib/yamwow/csv_generator.rb

@@ -1,27 +0,0 @@
-require 'csv'
-
-module YamWow
-  class CsvGenerator
-
-    attr_accessor :headers
-
-    def initialize
-      @headers = nil
-    end
-
-    def generate(items)
-      CSV.generate do |csv|
-        csv << headers_as_array if @headers
-        items.each { |i| csv << yield(i) }
-      end
-    end
-
-    private
-
-    def headers_as_array
-      return unless @headers
-      @headers.kind_of?(Array) ? @headers : @headers.split(',').map { |h| h.strip }
-    end
-
-  end
-end

data/lib/yamwow/group.rb

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

data/lib/yamwow/group_with_name_request.rb

@@ -1,40 +0,0 @@
-require_relative 'group'
-
-module YamWow
-  class GroupWithNameRequest
-
-    def initialize(client, group_name)
-      @client = client
-      @group_name = group_name.downcase.gsub(/[^0-9a-z]/i, '')
-    end
-
-    def send
-      build_group group_data
-    end
-
-    private
-
-    def group_data
-      data = send_autocomplete_request
-      groups = data['groups'] || []
-      groups.select { |g| g['name'] == @group_name }.first
-    end
-
-    def send_autocomplete_request
-      @client.get_autocomplete prefix: autocomplete_prefix
-    end
-
-    def autocomplete_prefix
-      'to:' + @group_name
-    end
-
-    def build_group(group_data)
-      return unless group_data
-      g = YamWow::Group.new
-      g.id = group_data['id']
-      g.name = group_data['full_name']
-      g
-    end
-
-  end
-end

data/lib/yamwow/message.rb

@@ -1,35 +0,0 @@
-require 'time'
-
-module YamWow
-  class Message
-
-    attr_accessor :id, :plain_body, :parsed_body, :date_created, :like_count, :url, :sender, :reply_to_id, :attachments
-
-    def sender_tag
-      "[[user:#{@sender.id}]]"
-    end
-
-    def sender_name
-      @sender.name
-    end
-
-    def plain_body_single_line
-      single_line @plain_body
-    end
-
-    def parsed_body_single_line
-      single_line @parsed_body
-    end
-
-    def thread_root?
-      @reply_to_id.nil?
-    end
-
-    private
-
-    def single_line(text)
-      text.gsub("\n", ' ').strip
-    end
-
-  end
-end

data/lib/yamwow/message_builder.rb

@@ -1,30 +0,0 @@
-module YamWow
-  class MessageBuilder
-
-    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
-
-    private
-
-    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
-
-  end
-end

data/lib/yamwow/praise.rb

@@ -1,57 +0,0 @@
-require_relative 'message'
-
-module YamWow
-  class Praise
-
-    def initialize(message)
-      @message = message
-    end
-
-    def sender_tag
-      @message.sender_tag
-    end
-
-    def sender_name
-      @message.sender_name
-    end
-
-    def date_created
-      @message.date_created
-    end
-
-    def like_count
-      @message.like_count
-    end
-
-    def url
-      @message.url
-    end
-
-    def recipient_tags
-      split_recipients @message.parsed_body
-    end
-
-    def recipient_names
-      split_recipients(@message.plain_body).map { |r| r.delete('@') }
-    end
-
-    def reason
-      attachments = @message.attachments || []
-      reason = attachments.map { |a| m = a['name'].match(/Praise: (.+)/m); m ? m[1] : nil }[0]
-      reason || @message.parsed_body
-    end
-
-    def reason_single_line
-      reason.gsub("\n", ' ').strip
-    end
-
-    private
-
-    def split_recipients(recipients)
-      recipients = recipients.include?('praised') ? recipients.match(/praised (.+)/)[1] : ''
-      recipients.gsub!(' and ', ', ')
-      recipients.split(', ')
-    end
-
-  end
-end

data/lib/yamwow/topic.rb

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

data/lib/yamwow/topic_with_name_request.rb

@@ -1,36 +0,0 @@
-require_relative 'topic'
-
-module YamWow
-  class TopicWithNameRequest
-
-    def initialize(client, topic_name)
-      @client = client
-      @topic_name = topic_name
-    end
-
-    def send
-      build_topic topic_data
-    end
-
-    private
-
-    def topic_data
-      data = send_autocomplete_request
-      topics = data['topics'] || []
-      topics.select { |t| t['name'].casecmp(@topic_name) == 0 }.first
-    end
-
-    def send_autocomplete_request
-      @client.get_autocomplete prefix: @topic_name
-    end
-
-    def build_topic(topic_data)
-      return unless topic_data
-      t = Topic.new
-      t.id = topic_data['id']
-      t.name = topic_data['name']
-      t
-    end
-
-  end
-end

data/lib/yamwow/topics_request.rb

@@ -1,44 +0,0 @@
-require_relative 'topic'
-
-module YamWow
-  class TopicsRequest
-
-    def initialize(client)
-      @client = client
-    end
-
-    def send
-      @topics = []
-      process_range '0', '9'
-      process_range 'a', 'z'
-      @topics.uniq! { |t| t.id }
-      @topics.sort! { |x, y| x.name.downcase <=> y.name.downcase }
-      @topics
-    end
-
-    private
-
-    def process_range(first, last, current=nil)
-      ((current.to_s + first)..(current.to_s + last)).each do |prefix|
-        response_data = send_autocomplete_request prefix
-        topics_data = response_data['topics'] || []
-        topics = topics_data.map { |t| build_topic t }
-        @topics += topics
-        process_range first, last, prefix if topics.length == 50
-      end
-    end
-
-    def send_autocomplete_request(prefix)
-      @client.get_autocomplete prefix: prefix.downcase
-    end
-
-    def build_topic(topic_data)
-      t = Topic.new
-      t.id = topic_data['id']
-      t.name = topic_data['name']
-      t.usages = topic_data['applications_count']
-      t
-    end
-
-  end
-end

data/lib/yamwow/user.rb

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