stackconnect 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 584521866f19a44852be42c2b887bc195a1a6b4c
-  data.tar.gz: 62ac6e796de6db00704ddbdea97346ca9a909f8c
+  metadata.gz: dd5c160ec1ddce3b067bdb2d49b6e26d74ca496f
+  data.tar.gz: 56888108a32e556061fdad166df30084f892099d
 SHA512:
-  metadata.gz: 8a7b8cd77e17362026ecf66d7ef953382bdf89c164ddbb5ce6cb95d98e5cc588ea5f755a467fd3500d99da127d6cc74ff77aa42e10f7c41a27df82fc748f5bef
-  data.tar.gz: 8ac1331b3d950d7e76fb822baeb2d30873b31b666ec3aff5d7f7cf0689e1bb897dc4b45a933c91ea4208eca096a757ed54573aca42ba3e5d48da114db3998bdc
+  metadata.gz: 3541ecd06dc2de5f44bbf0ac2a9917acc203e46c750512e9e6e95474087608eebdbe97ceee40e83f91f893a6a56592c002cf5d37ffcec042da7605a8b8a53900
+  data.tar.gz: 0668dc199a27a43c9da66017f558648446ee69561a2dd3795e348a5d21a720ce4a276aa27df48053a04620ebb402cbb0e20511db53ba3a5f9085d72f809cb887

data/README.md

@@ -1,24 +1,121 @@
-# Stack::Connect
+# StackConnect
 
-Ruby API for making StackOverflow queries
+Ruby API for making StackOverflow queries. This is a limited number of the API calls that can be made to the StackOverflow API, and these are all quota limited. So the response you get is not the full amount of data available, just the most popular/highest ranked data based on activity and date. 
 
 ## Installation
 
-Add this line to your application's Gemfile:
+In your Gemfile, add this line:
 
-    gem 'stack-connect'
+    gem 'stackconnect'
 
 And then execute:
 
-    $ bundle
+    $ bundle 
 
 Or install it yourself as:
 
-    $ gem install stack-connect
+    $ gem install stackconnect
 
 ## Usage
 
-TODO...
+These methods are quota restricted. The Stack Exchange API only allows a quota of 10000 without an API key: http://api.stackexchange.com/docs/authentication. Once you get over that quota without a key, your IP address will be throttled from making any more requests until the next day. 
+
+### Retrieve Total Number of Questions 
+
+`total = StackConnect.retrieve_total_questions(from_date)`
+
+This will return an number. 
+
+From date has to be in Unix date format. So for example, to retrieve the total number of questions from yesterday, 
+
+```
+ date = Date.today.to_time.to_i
+ total = StackConnect.retrieve_total_questions(from_date)
+```
+
+### Retrieve Most Popular Tags of All Time
+
+`data = StackConnect.retrieve_most_popular_tags`
+
+This will return a JSON data object which you can then parse. An example:
+
+```
+data["items"].each do |trend|
+   puts trend["name"]
+end
+```
+
+The data looks like this:
+```json 
+{
+  "items": [
+    {
+      "has_synonyms": false,
+      "is_moderator_only": false,
+      "is_required": false,
+      "count": 127787,
+      "name": "c"
+    },
+    {
+      "has_synonyms": true,
+      "is_moderator_only": false,
+      "is_required": false,
+      "count": 268773,
+      "name": "python"
+    },
+    {
+      "has_synonyms": true,
+      "is_moderator_only": false,
+      "is_required": false,
+      "count": 18729,
+      "name": "variables"
+    },
+  ],
+  "has_more": true,
+  "backoff": 10,
+  "quota_max": 10000,
+  "quota_remaining": 9973
+}
+```
+
+### Retrieving the Most Popular Tags of the Day
+
+These are sorted based on activity.
+
+`data = StackConnect.retrieve_day_popular_tags(from_date)`
+
+Sample Data:
+
+```json
+{
+  "items": [
+    {
+      "has_synonyms": false,
+      "is_moderator_only": false,
+      "is_required": false,
+      "count": 1,
+      "name": "microsoft-net-http"
+    },
+    {
+      "has_synonyms": false,
+      "is_moderator_only": false,
+      "is_required": false,
+      "count": 1,
+      "name": "owin-middleware"
+    },
+    {
+      "has_synonyms": false,
+      "is_moderator_only": false,
+      "is_required": false,
+      "count": 1,
+      "name": "mlt"
+    },
+  ],
+  "has_more": true,
+  "quota_max": 10000,
+  "quota_remaining": 9972
+}
+```
 
 ## Contributing
 

data/lib/stackconnect.rb

@@ -5,7 +5,7 @@ require 'uri'
 class StackConnect
   attr_accessor :api, :site, :uri
   
-  @@VERSION = "0.0.2"
+  @@VERSION = "0.0.4"
   @@api = 'http://api.stackexchange.com/'
   @@site = 'stackoverflow'
   @@uri = URI(@@api)
@@ -23,6 +23,12 @@ class StackConnect
     data = JSON.parse(@@uri.open.read)
   end
 
+  def retrieve_day_popular_tags(from_date)
+    @@uri.path = '/2.1/tags'
+    @@uri.query = ({ :fromdate => from_date, :site=>'stackoverflow', :sort => 'activity', :order=>'desc'}).to_query
+    data = JSON.parse(@@uri.open.read)
+  end 
+
   def self.return_version
     @@VERSION
   end

data/spec/stack_spec.rb

@@ -14,6 +14,10 @@ describe StackConnect do
   it "retrieve popular tags should return array" do
     @connect.retrieve_most_popular_tags.should be_a(Hash)
   end 
+
+  it "retrieve popular tags of the days returns array" do
+    date = Date.today.to_time.to_i
+    @connect.retrieve_day_popular_tags(date).should be_a(Hash)
+  end
 end
     
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackconnect
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - amirtcheva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-14 00:00:00.000000000 Z
+date: 2014-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cucumber