conversocial 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c43003f6dc1bf8accf333960ecf3b2007067ff1
-  data.tar.gz: 84a988b6866afacbac1f41f48c74d986b6bb4cb3
+  metadata.gz: 39314cece44480bb907b43d273ebac7380338506
+  data.tar.gz: e09b7ce8e03411f766bae1c63987517d4dca844a
 SHA512:
-  metadata.gz: 9c108a618244ce1790d069d3875b560662c260eff7078c1c9f4e15495cef27efdd50e18ddb5e42dff38ff1ba3b2850fefecd5ab13f640e71487611d50ce742da
-  data.tar.gz: 1fa44ea6c3e921cab7b6a46422c49126904da39f94822a78b79169d8b5c2b1503e539ae14f23dfaccbf5cf1412d05c44592063b297eec6ae7c0892f349853dc3
+  metadata.gz: 9430b25701982c8bea259beac69fdcd50b38373269cbef6bab93c24a34009d4ff03f1476909c49e571f076041c1850351f3d57dded34e1844ff0890cc78cecbb
+  data.tar.gz: e441b23bb382487ffd1cb2d26c184ed455baaba1e9e373e25ec9b66d329da10bdc55c7bf2d76fd2b21539e2a6d1d5f5b96c4dbae4cec0a183db449c324d4f64d

data/README.md

@@ -1,6 +1,6 @@
 # Conversocial
 
-TODO: Write a gem description
+Ruby gem that wraps the conversocial api in an ORM pattern
 
 ## Installation
 
@@ -18,7 +18,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Disclaimer: I am still working on in depth documentation for this gem. In the meantime, I tried to provide some quick example snippets here.
+
+Initialize the client with your key and secret
+
+    client = Conversocial::Client.new :key => '...', :secret => '...'
+
+And then fetch some data
+
+    client.conversations.limit(3).fetch #note that limit is only supported on conversations
+    client.conversations.where( :status => 'unread' ).fetch
+    client.tags.fetch
+    client.users.fetch
+    client.accounts.fetch
+    client.channels.fetch
+    client.reports.fetch
+
+To find a resource by id
+
+    client.accounts.find 13954
+    client.tags.find 98999
+
+To paginate through all of a certain resource do
+
+    client.tags.each_page{ |tags| .... }
+    client.conversations( :status => 'unread' ).each_page{ |conversations| puts "conversation ids on this page are #{conversations.map(&:id).inspect}" }
+
+To get all the conversations for today
+
+    client.conversations.order(:oldest_sort_date).greater_than_or_equal_to(:oldest_sort_date, Date.today ).limit(50).each_page{ |conversations| ... }
+
+
+
+Items not yet supported, but that will be in a soon future version
+
+    -saving of reports
+    -the keyvalue resource
 
 ## Contributing
 

data/conversocial.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["mishaAconway@gmail.com"]
   spec.summary       = %q{Ruby gem that wraps the conversocial api in an ORM pattern}
   spec.description   = %q{Ruby gem that wraps the conversocial api in an ORM pattern}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/MishaConway/ruby-conversocial"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/conversocial/resources/query_engines/base.rb

@@ -50,6 +50,12 @@ module Conversocial
         end
 
         def where options
+          options = options.map do |k,v|
+            v =  v.utc.strftime '%Y-%m-%dT%H:%M:%S' if v.kind_of? Time
+            v = v.to_s if v.kind_of? Date
+            [k,v]
+          end.to_h
+
           @query_params.merge! options
           self
         end
@@ -74,10 +80,7 @@ module Conversocial
         def size
           fetch.size
         end
-
-        def count
-          size
-        end
+        alias :count :size
 
         def last
           fetch.last
@@ -88,11 +91,40 @@ module Conversocial
           (fetch_ex add_query_params("", default_fetch_query_params.merge(@query_params)))[:items]
         end
 
-        protected
 
+        def sort field
+          field = field.join ',' if field.kind_of? Array
+          where :sort => field
+        end
+        alias :sort_by :sort
+        alias :order :sort
+        alias :order_by :sort
+
+        def greater_than field, value
+          comparison_filter field, "gt", value
+        end
+
+        def greater_than_or_equal_to field, value
+          comparison_filter field, "gte", value
+        end
+
+        def lesser_than field, value
+          comparison_filter field, "lt", value
+        end
+
+        def less_than_or_equal_to field, value
+          comparison_filter field, "lte", value
+        end
 
+        def to_fetch_url
+          absolute_path add_query_params("", default_fetch_query_params.merge(@query_params))
+        end
 
+        protected
 
+        def comparison_filter field, comparison_operator_modifier, value
+          where "#{field}_#{comparison_operator_modifier}".to_sym => value
+        end
 
         def fetch_ex url
           json = get_json url
@@ -148,7 +180,7 @@ module Conversocial
           else
             if 404 == response.code.to_i
               if json['message'] == "No such #{resource_name}"
-               # puts "returning nil here"
+                #puts "returning nil here"
                 return nil
               end
             end

data/lib/conversocial/version.rb

@@ -1,3 +1,3 @@
 module Conversocial
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conversocial
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Misha Conway
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-28 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,7 +76,7 @@ files:
 - lib/conversocial/resources/query_engines/tag.rb
 - lib/conversocial/resources/query_engines/user.rb
 - lib/conversocial/version.rb
-homepage: ''
+homepage: https://github.com/MishaConway/ruby-conversocial
 licenses:
 - MIT
 metadata: {}