stack_overflow 0.0.8 → 0.0.9

data/.gitignore

@@ -3,3 +3,4 @@ pkg/*
 .bundle
 *.swp
 **/*.swp
+.idea/

data/Gemfile.lock

@@ -1,24 +1,26 @@
 PATH
   remote: .
   specs:
-    stack_overflow (0.0.7)
+    stack_overflow (0.0.9)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    crack (0.1.8)
-    diff-lcs (1.1.2)
-    httparty (0.6.1)
-      crack (= 0.1.8)
-    json (1.4.6)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
+    diff-lcs (1.1.3)
+    httparty (0.8.1)
+      multi_json
+      multi_xml
+    json (1.6.3)
+    multi_json (1.0.4)
+    multi_xml (0.4.1)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rspec-mocks (2.7.0)
 
 PLATFORMS
   ruby

data/README.rdoc

@@ -1,5 +1,7 @@
 = Stack Overflow
 
+*Ive* *namespaced* *this* *gem* *to* API::StackOverflow *so* *that* *I* *could* *use* 'StackOverflow' *for* *other* *namespacing* *purposes*
+
 This is a simple gem that utilizes HTTParty and the StackOverflow API.
 
 	gem install stack_overflow
@@ -10,7 +12,7 @@ The StackOverflow API help can be found at http://api.stackoverflow.com/1.1/usag
 
 Be sure to set the API Key.
 
-	StackOverflow.API_KEY = YOUR_KEY_GOES_HERE
+	API::StackOverflow.API_KEY = YOUR_KEY_GOES_HERE
 	
 You can get your key from StackOverflow by going here : http://stackapps.com/apps/register
 
@@ -18,51 +20,51 @@ You can get your key from StackOverflow by going here : http://stackapps.com/app
 
 API documentation can be found at http://api.stackoverflow.com/1.1/usage/methods/users
 
-  StackOverflow.get_all_users
+  API::StackOverflow.get_all_users
 
 By default the api returns the first page of users with 30 per page. This information can be read from the results. To get additional pages or change the pagesize (0-100) you can make call like:
 
-  StackOverflow.get_all_users(:page => 2, :per_page => 50)
+  API::StackOverflow.get_all_users(:page => 2, :per_page => 50)
 
 == Get User(s)
 
 API documentation can be found at	http://api.stackoverflow.com/1.1/usage/methods/users-by-ids
 	
-	StackOverflow.get_user(#user_id)
+	API::StackOverflow.get_user(#user_id)
 	
 You can also get a group of users by using
 
-	StackOverflow.get_users([#user_id1, #user_id2, etc])
+	API::StackOverflow.get_users([#user_id1, #user_id2, etc])
 
 == Get User's Tags
 
 API documentation can be found at http://api.stackoverflow.com/1.1/usage/methods/user-tags
 
-	StackOverflow.get_user_tags(#user_id)
+	API::StackOverflow.get_user_tags(#user_id)
 
 == Get User's Questions
 
 API documentation can be found at http://api.stackoverflow.com/1.1/usage/methods/questions
 
-	StackOverflow.get_user_questions(#user_id)
+	API::StackOverflow.get_user_questions(#user_id)
 
 == Get User's Answers
 
 API documentation can be found at http://api.stackoverflow.com/1.1/usage/methods/answers
 
-	StackOverflow.get_user_answers(#user_id)
+	API::StackOverflow.get_user_answers(#user_id)
 
 == Get Tags
 
 API documentation can be found at http://api.stackoverflow.com/1.1/usage/methods/tags
 
-  StackOverflow.get_tags
+  API::StackOverflow.get_tags
 
 == Get Tags Synonyms
 
 API documentation can be found at http://api.stackoverflow.com/1.1/usage/methods/tag-synonyms
 
-  StackOverflow.get_tags_synonyms
+  API::StackOverflow.get_tags_synonyms
 
 == Work in progress
 

data/lib/answer.rb

@@ -0,0 +1,29 @@
+module API
+  module StackOverflow
+    class Answer
+      attr_accessor :id, :accepted, :comments_url, :question_id, :title
+      attr_accessor :creation_date, :last_activity_date
+      attr_accessor :up_vote_count, :down_vote_count, :view_count, :score, :community_owned
+
+      def initialize(so_answer)
+        @id = so_answer["answer_id"]
+        @title = so_answer["title"]
+        @accepted = so_answer["accepted"]
+        @comments_url = so_answer["answer_comments_url"]
+        @question_id = so_answer["question_id"]
+        @creation_date = Time.at(so_answer["creation_date"]) if so_answer["creation_date"]
+        @last_activity_date = Time.at(so_answer["last_activity_date"]) if so_answer["last_activity_date"]
+        @up_vote_count = so_answer["up_vote_count"]
+        @down_vote_count = so_answer["down_vote_count"]
+        @view_count = so_answer["view_count"]
+        @score = so_answer["score"]
+        @community_owned = so_answer["community_owned"]
+      end
+
+      def vote_count
+        @up_vote_count - @down_vote_count
+      end
+
+    end
+  end
+end

data/lib/question.rb

@@ -0,0 +1,35 @@
+module API
+  module StackOverflow
+    class Question
+      attr_accessor :answer_count, :accepted_answer_id, :favorite_count, :timeline_url
+      attr_accessor :comments_url, :answers_url, :id
+      attr_accessor :creation_date, :last_edit_date, :last_activity_date
+      attr_accessor :up_vote_count, :down_vote_count, :view_count, :score
+      attr_accessor :community_owned, :title
+
+      def initialize(so_question)
+        @id = so_question["question_id"]
+        @answer_count = so_question["answer_count"]
+        @accepted_answer_id = so_question["accepted_answer_id"]
+        @favorite_count = so_question["favorite_count"]
+        @timeline_url = so_question["question_timeline_url"]
+        @comments_url = so_question["question_comments_url"]
+        @answers_url = so_question["question_answers_url"]
+        @creation_date = Time.at(so_question["creation_date"]) if so_question["creation_date"]
+        @last_edit_date = Time.at(so_question["last_edit_date"]) if so_question["last_edit_date"]
+        @last_activity_date = Time.at(so_question["last_activity_date"]) if so_question["last_activity_date"]
+        @up_vote_count = so_question["up_vote_count"]
+        @down_vote_count = so_question["down_vote_count"]
+        @view_count = so_question["view_count"]
+        @score = so_question["score"]
+        @community_owned = so_question["community_owned"]
+        @title = so_question["title"]
+      end
+
+      def vote_count
+        @up_vote_count - @down_vote_count
+      end
+
+    end
+  end
+end

data/lib/stack_overflow.rb

@@ -1,58 +1,61 @@
 require 'httparty'
 require 'json'
+require 'question'
+require 'answer'
+
+module API
+  module StackOverflow
+    include HTTParty
+    @@API_KEY = nil
+    @@URL = "http://api.stackoverflow.com/1.1/"
+
+    def self.API_KEY=(value)
+      @@API_KEY = value
+    end
+
+    def self.get_all_users(options={})
+      key = @@API_KEY
+      page = options[:page] || 1
+      pagesize = options[:pagesize] || 30
+      url = URI.parse(@@URL + "users?key=#{key}&page=#{page}&pagesize=#{pagesize}")
+      response = Net::HTTP.get_response url
+      gz = Zlib::GzipReader.new(StringIO.new(response.body))
+      JSON.parse(gz.read)
+    end
+
+    def self.get_user(user_id)
+      result = get(@@URL + "users/#{user_id}?key=#{@@API_KEY}")
+      return nil if result["users"].nil?
+      result["users"].first
+    end
+
+    def self.get_users(user_ids)
+      user_id = user_ids.join(";").to_s
+      result = get(@@URL + "users/#{user_id}?key=#{@@API_KEY}")
+      result["users"]
+    end
+
+    def self.get_user_questions(user_id)
+      result = get(@@URL + "users/#{user_id}/questions?key=#{@@API_KEY}")
+      result["questions"].map{|q| Question.new(q) }
+    end
+
+    def self.get_user_answers(user_id)
+      result = get(@@URL + "users/#{user_id}/answers?key=#{@@API_KEY}")
+      result["answers"].map{|a| Answer.new(a) }
+    end
+
+    def self.get_user_tags(user_id)
+      get(@@URL + "users/#{user_id}/tags?key=#{@@API_KEY}")
+    end
+
+    def self.get_tags
+      get(@@URL + "tags?key=#{@@API_KEY}")
+    end
+
+    def self.get_tags_synonyms
+      get(@@URL + "tags/synonyms?key=#{@@API_KEY}")
+    end
 
-class StackOverflow
-  include HTTParty
-  @@API_KEY = nil
-  @@URL = "http://api.stackoverflow.com/1.1/"
-
-  def self.API_KEY=(value)
-    @@API_KEY = value
-  end
-
-  def self.get_all_users(options={})
-    key = @@API_KEY
-    page = options[:page] || 1
-    pagesize = options[:pagesize] || 30
-    url = URI.parse(@@URL + "users?key=#{key}&page=#{page}&pagesize=#{pagesize}")
-    response = Net::HTTP.get_response url
-    gz = Zlib::GzipReader.new(StringIO.new(response.body))
-    JSON.parse(gz.read)
-  end
-
-  def self.get_user(user_id)
-    result = get(@@URL + "users/#{user_id}?key=#{@@API_KEY}")
-    return nil if result["users"].nil?
-    result["users"].first
   end
-  
-  def self.get_users(user_ids)
-    user_id = user_ids.join(";").to_s
-    result = get(@@URL + "users/#{user_id}?key=#{@@API_KEY}")
-    result["users"]  
-  end
-
-  def self.get_user_questions(user_id)
-    result = get(@@URL + "users/#{user_id}/questions?key=#{@@API_KEY}") 
-    result["questions"]
-  end
-
-
-  def self.get_user_answers(user_id)
-    result = get(@@URL + "users/#{user_id}/answers?key=#{@@API_KEY}") 
-    result["answers"]
-  end
-  
-  def self.get_user_tags(user_id)
-    get(@@URL + "users/#{user_id}/tags?key=#{@@API_KEY}")
-  end
-
-  def self.get_tags
-    get(@@URL + "tags?key=#{@@API_KEY}")
-  end
-
-  def self.get_tags_synonyms
-    get(@@URL + "tags/synonyms?key=#{@@API_KEY}")
-  end
-
 end

data/lib/stack_overflow/version.rb

@@ -1,3 +1,5 @@
-module StackOverflow
-  VERSION = "0.0.8"
+module API
+  module StackOverflow
+    VERSION = "0.0.9"
+  end
 end

data/spec/get_answers_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe "get users answers" do
+  context "363881" do
+    before(:each) do
+      @answers = API::StackOverflow.get_user_answers(363881)
+    end
+    it { @answers.should_not be_nil }
+    it { @answers.count.should > 0 }
+  end
+end

data/spec/get_questions_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe "get users questions" do
+  context "363881" do
+    before(:each) do
+      @questions = API::StackOverflow.get_user_questions(363881)
+    end
+    it { @questions.should_not be_nil }
+    it { @questions.count.should > 0 }
+  end
+end

data/spec/stack_overflow_spec.rb

@@ -1,28 +1,28 @@
 require 'spec_helper'
 
-describe StackOverflow do
+describe API::StackOverflow do
   before(:each) do
-    StackOverflow.API_KEY = ENV["SO_API_KEY"]
+    API::StackOverflow.API_KEY = ENV["SO_API_KEY"]
   end
 
   describe "get all users" do
     context "all users" do 
       before(:each) do
-        @result = StackOverflow.get_all_users
+        @result = API::StackOverflow.get_all_users
       end
       it { @result.should_not be_nil }
     end
 
     context "second page" do
       before(:each) do
-        @result = StackOverflow.get_all_users(:page => 2)
+        @result = API::StackOverflow.get_all_users(:page => 2)
       end
       it { @result.should_not be_nil }
     end
 
     context "50 per page" do
       before(:each) do
-        @result = StackOverflow.get_all_users(:pagesize => 50)
+        @result = API::StackOverflow.get_all_users(:pagesize => 50)
       end
       it { @result["users"].count.should == 50 }
     end
@@ -31,7 +31,7 @@ describe StackOverflow do
   describe "get user" do
     context "60336" do
       before(:each) do
-        @user = StackOverflow.get_user(60336)
+        @user = API::StackOverflow.get_user(60336)
       end
       it { @user.should_not be_nil }
       it { @user["display_name"].should == "JB."}
@@ -39,7 +39,7 @@ describe StackOverflow do
     
     context "Jared314" do
       before(:each) do
-        @user = StackOverflow.get_user("Jared314")
+        @user = API::StackOverflow.get_user("Jared314")
       end
       it { @user.should be_nil }      
     end
@@ -47,7 +47,7 @@ describe StackOverflow do
   
   describe "get users" do
     before(:each) do
-      @users = StackOverflow.get_users([60336, 3381])
+      @users = API::StackOverflow.get_users([60336, 3381])
     end
     it { @users.should_not be_nil }
     it { @users.select{|u| u["display_name"] == "JB"}.should_not be_nil }
@@ -56,7 +56,7 @@ describe StackOverflow do
   
   describe "get user tags" do
     before(:each) do
-      @tags = StackOverflow.get_user_tags(60336)
+      @tags = API::StackOverflow.get_user_tags(60336)
     end
     it { @tags.should_not be_nil }
     it { @tags["tags"].count.should > 0 }
@@ -64,7 +64,7 @@ describe StackOverflow do
 
   describe "get tags" do
     before(:each) do
-      @tags = StackOverflow.get_tags
+      @tags = API::StackOverflow.get_tags
     end
     it { @tags.should_not be_nil }
     it { @tags["tags"].count.should > 0 }
@@ -72,26 +72,12 @@ describe StackOverflow do
 
   describe "get tags synonyms" do
     before(:each) do
-      @tags_synonyms = StackOverflow.get_tags_synonyms
+      @tags_synonyms = API::StackOverflow.get_tags_synonyms
     end
     it { @tags_synonyms.should_not be_nil }
     it { @tags_synonyms["tag_synonyms"].count.should > 0 }
   end
 
-  describe "get users answers" do
-    before(:each) do
-      @answers = StackOverflow.get_user_answers(363881)
-    end
-    it { @answers.should_not be_nil }
-    it { @answers.count.should > 0 }
-  end
 
-  describe "get users questions" do
-    before(:each) do
-      @questions = StackOverflow.get_user_questions(363881)
-    end
-    it { @questions.should_not be_nil }
-    it { @questions.count.should > 0 }
-  end
 
 end

data/stack_overflow.gemspec

@@ -4,7 +4,7 @@ require "stack_overflow/version"
 
 Gem::Specification.new do |s|
   s.name        = "stack_overflow"
-  s.version     = StackOverflow::VERSION
+  s.version     = API::StackOverflow::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Jonathan Birkholz"]
   s.email       = ["rookieone@gmail.com"]

metadata

@@ -2,7 +2,7 @@
 name: stack_overflow
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors: 
 - Jonathan Birkholz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-31 00:00:00 Z
+date: 2012-01-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -60,9 +60,12 @@ files:
 - Gemfile.lock
 - README.rdoc
 - Rakefile
-- lib/.stack_overflow.rb.swp
+- lib/answer.rb
+- lib/question.rb
 - lib/stack_overflow.rb
 - lib/stack_overflow/version.rb
+- spec/get_answers_spec.rb
+- spec/get_questions_spec.rb
 - spec/spec_helper.rb
 - spec/stack_overflow_spec.rb
 - stack_overflow.gemspec
@@ -94,5 +97,7 @@ signing_key:
 specification_version: 3
 summary: HTTParty over the StackOverflow API
 test_files: 
+- spec/get_answers_spec.rb
+- spec/get_questions_spec.rb
 - spec/spec_helper.rb
 - spec/stack_overflow_spec.rb