betterific 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODc5NGU1YjY0OTM2ZmM3NjViYzk1ZjNjM2YyN2E1OWE5ODM2ZDZlMA==
+  data.tar.gz: !binary |-
+    ZDljN2Y0MTU3MjIzMzllMDhkMjlhMTJhNjg3MWE3NTg5ZDJhNDM0OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjIzZjJiOTFkODZmMDkyODkzMzc3ZWM4ZWVkODBlODhmOTA0Mjk2YWRjOWI0
+    Yjg2YTkyNTI2NTczMzQ4NmNlZTJmMWI4OWUxYmNkZTc0NDc3N2ZmZTdjNTQz
+    NWNkMWNlNTVmMTM1NzI0ZTlhZWZjOTIwZTJiNDI0YWQwZGYxYmM=
+  data.tar.gz: !binary |-
+    YzIwNjUyNDJlNWZiYmFhODBkODRlYzFjODAzZDg4MmE1N2ZiMzk5ZDFhZGUy
+    YzM5MjA3ZDVjZTQyODAzMTg3OWIzNzhkYjc5YmIzZGZkMjg4YmYwZDNjZTdj
+    MDdkYzRlOTAyMmFhZjk4ZTBmNzE0MWZiMTQyNDUyNTEwOTA1ZWM=

data/README.md

@@ -55,6 +55,21 @@ you can use
 
     Betterific::Client.betterifs(:ids => [id0, id1, ...])
 
+### Comments
+
+You can see a list of comments by id or by betterif\_id using
+
+    Betterific::Client.comments(:ids => [id0, id1, ...])
+
+and
+
+    Betterific::Client.comments(:betterif_ids => [id0, id1, ...])
+
+If using betterif\_ids, you may also specify the desired sort order, which can
+be either least\_recent or most\_recent
+
+    Betterific::Client.comments(:betterif_ids => [id0, id1, ...], :order => 'least_recent')
+
 ### Tags and Users
 
 You can see a list of tags or users by id using

data/lib/betterific/client_constants.rb

@@ -5,6 +5,8 @@ module Betterific
 
     # The base URL to GET betterifs.
     BETTERIFS_BASE_URL = "#{BASE_URL}/betterifs".freeze
+    # The base URL to GET comments.
+    COMMENTS_BASE_URL = "#{BASE_URL}/comments".freeze
     # The base URL to GET tags.
     TAGS_BASE_URL = "#{BASE_URL}/tags".freeze
     # The base URL to GET users.

data/lib/betterific/json_client.rb

@@ -39,6 +39,35 @@ module Betterific
       end
     end
 
+    # Get a list of comments.
+    #
+    # ==== Parameters
+    #
+    # * +opts+ - {:ids => [id0, id1, ..., idx]} specifies the ids of the
+    #   comment(s) to return.
+    # * +opts+ - {:betterif_ids => [id0, id1, ..., idx]} specifies the ids of
+    #   the betterif(s) for which to return comments. This is ignored if :ids
+    #   is given.
+    # * +opts+ - {:order => (least_recent|most_recent)} fetches either the
+    #   least recent or most recent comments. This is ignored unless
+    #   :betterif_ids is given.
+    def self.comments(opts={})
+      if opts[:ids].nil? && opts[:betterif_ids].nil?
+        raise "No ids or betterif_ids given."
+      end
+      unless opts[:order].nil?
+        unless %w{least_recent most_recent}.include?(opts[:order])
+          raise "Invalid order given."
+        end
+      end
+      params = [
+        opts[:ids] ? "comments[ids]=#{Array(opts[:ids]).map(&:to_s).join(',')}" : nil,
+        opts[:betterif_ids] ? "betterifs[ids]=#{Array(opts[:betterif_ids]).map(&:to_s).join(',')}" : nil,
+        opts[:order] ? "order=#{opts[:order]}" : nil
+      ].compact
+      get_json("#{COMMENTS_BASE_URL}?#{params.join('&')}")
+    end
+
     # Get a list of tags.
     #
     # ==== Parameters

data/lib/betterific/protobuf_client.rb

@@ -107,6 +107,35 @@ module Betterific
       end
     end
 
+    # Get a list of comments.
+    #
+    # ==== Parameters
+    #
+    # * +opts+ - {:ids => [id0, id1, ..., idx]} specifies the ids of the
+    #   comment(s) to return.
+    # * +opts+ - {:betterif_ids => [id0, id1, ..., idx]} specifies the ids of
+    #   the betterif(s) for which to return comments. This is ignored if :ids
+    #   is given.
+    # * +opts+ - {:order => (least_recent|most_recent)} fetches either the
+    #   least recent or most recent comments. This is ignored unless
+    #   :betterif_ids is given.
+    def self.comments(opts={})
+      if opts[:ids].nil? && opts[:betterif_ids].nil?
+        raise "No ids or betterif_ids given."
+      end
+      unless opts[:order].nil?
+        unless %w{least_recent most_recent}.include?(opts[:order])
+          raise "Invalid order given."
+        end
+      end
+      params = [
+        opts[:ids] ? "comments[ids]=#{Array(opts[:ids]).map(&:to_s).join(',')}" : nil,
+        opts[:betterif_ids] ? "betterifs[ids]=#{Array(opts[:betterif_ids]).map(&:to_s).join(',')}" : nil,
+        opts[:order] ? "order=#{opts[:order]}" : nil
+      ].compact
+      get_protobuf("#{COMMENTS_BASE_URL}?#{params.join('&')}")
+    end
+
     # Get a list of tags.
     #
     # ==== Parameters

data/lib/betterific/version.rb

@@ -1,3 +1,3 @@
 module Betterific
-  VERSION = "0.0.2" #:nodoc:
+  VERSION = "0.0.3" #:nodoc:
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require 'betterific'
+require 'time'
 
+BETTERIFIC_COMMENT_ID = 121 #:nodoc
 BETTERIFIC_TAG_ID = 400937 #:nodoc
 BETTERIF_ID = 224 #:nodoc
 USER_ID = 2 #:nodoc
@@ -7,10 +9,12 @@ USER_ID = 2 #:nodoc
 SEARCH_KINDS = %w{betterifs tags users}.freeze #:nodoc
 
 def ensure_valid_api_response(resp, client_modjule, opts={})
-  if opts[:big]
-    resp.total_results.should > 10
-  else
-    resp.total_results.should >= (opts[:allow_empty] ? 0 : 1)
+  unless opts[:comments]
+    if opts[:big]
+      resp.total_results.should > 10
+    else
+      resp.total_results.should >= (opts[:allow_empty] ? 0 : 1)
+    end
   end
   if opts[:big]
     resp.num_results.should == 10
@@ -28,7 +32,7 @@ def ensure_valid_api_response(resp, client_modjule, opts={})
         resp.betterifs.first.tags.is_a?(Array).should == true
       elsif client_modjule == Betterific::ProtobufClient
         resp.betterifs.first.tags.is_a?(ProtocolBuffers::RepeatedField).should == true
-      else
+      elsif client_modjule != Betterific::Client
         raise "Invalid client_modjule #{client_modjule}"
       end
       if resp.betterifs.first.tags.size > 0
@@ -41,6 +45,23 @@ def ensure_valid_api_response(resp, client_modjule, opts={})
       end
     end
   end
+  if opts[:comments]
+    if opts[:big]
+      resp.comments.size.should == 10
+    else
+      resp.comments.size.should >= (opts[:allow_empty] ? 0 : 1)
+    end
+    if client_modjule == Betterific::JsonClient
+      resp.comments.is_a?(Array).should == true
+    elsif client_modjule == Betterific::ProtobufClient
+      resp.comments.is_a?(ProtocolBuffers::RepeatedField).should == true
+    elsif client_modjule != Betterific::Client
+      raise "Invalid client_modjule #{client_modjule}"
+    end
+    if client_modjule == Betterific::ProtobufClient && resp.comments.size > 0
+      resp.comments.first.is_a?(BetterIf::Comment).should == true
+    end
+  end
   if opts[:tags]
     if opts[:big]
       resp.tags.size.should == 10
@@ -51,7 +72,7 @@ def ensure_valid_api_response(resp, client_modjule, opts={})
       resp.tags.is_a?(Array).should == true
     elsif client_modjule == Betterific::ProtobufClient
       resp.tags.is_a?(ProtocolBuffers::RepeatedField).should == true
-    else
+    elsif client_modjule != Betterific::Client
       raise "Invalid client_modjule #{client_modjule}"
     end
     if client_modjule == Betterific::ProtobufClient && resp.tags.size > 0
@@ -68,7 +89,7 @@ def ensure_valid_api_response(resp, client_modjule, opts={})
       resp.users.is_a?(Array).should == true
     elsif client_modjule == Betterific::ProtobufClient
       resp.users.is_a?(ProtocolBuffers::RepeatedField).should == true
-    else
+    elsif client_modjule != Betterific::Client
       raise "Invalid client_modjule #{client_modjule}"
     end
     if client_modjule == Betterific::ProtobufClient && resp.users.size > 0
@@ -85,26 +106,58 @@ def client_test(modjule)
         [:most_popular, :most_recent].each do |filter|
           it "should load #{filter} betterifs" do
             resp = modjule.betterifs(page_params.merge(:filter => filter))
-            ensure_valid_api_response(resp, :betterifs => true, :big => page_params.empty?)
+            ensure_valid_api_response(resp, modjule, :betterifs => true, :big => page_params.empty?)
           end
         end
         it "should load betterifs via ids" do
           resp = modjule.betterifs(page_params.merge(:ids => BETTERIF_ID))
-          ensure_valid_api_response(resp, :betterifs => true, :allow_empty => !page_params.empty?)
+          ensure_valid_api_response(resp, modjule, :betterifs => true, :allow_empty => !page_params.empty?)
           if page_params.empty?
             resp.betterifs.first.id.should == BETTERIF_ID
           end
         end
+        it "should load comments via ids" do
+          resp = modjule.comments(page_params.merge(:ids => BETTERIFIC_COMMENT_ID))
+          ensure_valid_api_response(resp, modjule, :comments => true, :allow_empty => !page_params.empty?)
+          if page_params.empty?
+            resp.comments.first.id.should == BETTERIFIC_COMMENT_ID
+          end
+        end
+        it "should load comments via betterif_ids" do
+          resp = modjule.comments(page_params.merge(:betterif_ids => BETTERIF_ID))
+          ensure_valid_api_response(resp, modjule, :comments => true, :allow_empty => !page_params.empty?)
+          if page_params.empty?
+            resp.comments.first.betterif.id.should == BETTERIF_ID
+          end
+        end
+        %w{least_recent most_recent}.each do |order|
+          it "should load comments via betterif_ids and #{order}" do
+            resp = modjule.comments(page_params.merge(:betterif_ids => BETTERIF_ID, :order => order))
+            ensure_valid_api_response(resp, modjule, :comments => true, :allow_empty => !page_params.empty?)
+            if page_params.empty?
+              resp.comments.first.betterif.id.should == BETTERIF_ID
+              if resp.comments.size > 1
+                first_comment_created_at = Time.parse(resp.comments.first.created_at)
+                last_comment_created_at = Time.parse(resp.comments.last.created_at)
+                if order == 'least_recent'
+                  first_comment_created_at.should < last_comment_created_at
+                else
+                  first_comment_created_at.should > last_comment_created_at
+                end
+              end
+            end
+          end
+        end
         it "should load tags via ids" do
           resp = modjule.tags(page_params.merge(:ids => BETTERIFIC_TAG_ID))
-          ensure_valid_api_response(resp, :tags => true, :allow_empty => !page_params.empty?)
+          ensure_valid_api_response(resp, modjule, :tags => true, :allow_empty => !page_params.empty?)
           if page_params.empty?
             resp.tags.first.id.should == BETTERIFIC_TAG_ID
           end
         end
         it "should load users via ids" do
           resp = modjule.users(page_params.merge(:ids => USER_ID))
-          ensure_valid_api_response(resp, :users => true, :allow_empty => !page_params.empty?)
+          ensure_valid_api_response(resp, modjule, :users => true, :allow_empty => !page_params.empty?)
           if page_params.empty?
             resp.users.first.id.should == USER_ID
           end
@@ -115,7 +168,7 @@ def client_test(modjule)
             q = [random_query, random_query].join(' ')
             resp = modjule.search(page_params.merge(:namespace => kind, :q => q))
             resp.q.should == q
-            ensure_valid_api_response(resp.send(kind), kind.to_sym => true, :allow_empty => true)
+            ensure_valid_api_response(resp.send(kind), modjule, kind.to_sym => true, :allow_empty => true)
             if modjule == Betterific::JsonClient
               SEARCH_KINDS.each do |other_kind|
                 next if kind == other_kind
@@ -129,7 +182,7 @@ def client_test(modjule)
           resp = modjule.search(page_params.merge(:namespace => :all, :q => q))
           resp.q.should == q
           SEARCH_KINDS.each do |kind|
-            ensure_valid_api_response(resp.send(kind), kind.to_sym => true, :allow_empty => true)
+            ensure_valid_api_response(resp.send(kind), modjule, kind.to_sym => true, :allow_empty => true)
           end
         end
       end

metadata

@@ -1,80 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: betterific
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Brad Cater
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-13 00:00:00.000000000 Z
+date: 2013-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.5
-  prerelease: false
+  name: hashie
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.5
+  prerelease: false
 - !ruby/object:Gem::Dependency
-  name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
-  prerelease: false
+  name: json
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
+  prerelease: false
 - !ruby/object:Gem::Dependency
-  name: ruby-protocol-buffers
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.0
-  prerelease: false
+  name: ruby-protocol-buffers
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.0
+  prerelease: false
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.0
-  prerelease: false
+  name: rspec
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.0
+  prerelease: false
 description: This gem is a Ruby interface to the Betterific API.
 email:
 - bradcater@gmail.com
@@ -103,27 +94,26 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/bradcater/betterific
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: This gem is a Ruby interface to the Betterific API. It provides support via
   Protocol Buffers if the ruby-protocol-buffers gem is installed; otherwise, it uses
   JSON.