whereistand 0.0.2 → 0.0.3

data/CHANGELOG

@@ -1,3 +1,5 @@
+  v0.0.3. implemented account, issue, and opinion services, all unit tests succeeding
+
   v0.0.2. revising accessibility and naming conventions 
 
   v0.0.1. initial release

data/Gemfile

@@ -2,10 +2,6 @@ source "http://rubygems.org"
 
 gem "yajl-ruby"
 
-group :development do
-	gem "parka"
-end
-
 group :test do
 	gem "rspec"
 end

data/Manifest

@@ -3,9 +3,12 @@ Gemfile
 Gemfile.lock
 LICENSE
 Manifest
-README
+README.rdoc
 Rakefile
-lib/client/access.rb
+lib/client/accounts.rb
+lib/client/issues.rb
+lib/client/opinions.rb
+lib/client/tools.rb
 lib/dom/account.rb
 lib/dom/account_issues.rb
 lib/dom/account_results.rb
@@ -21,4 +24,6 @@ lib/dom/results.rb
 lib/dom/unknown_opinion.rb
 lib/dom/unverified_opinion.rb
 lib/whereistand.rb
-spec/client_access_spec.rb
+spec/client_accounts_spec.rb
+spec/client_issues_spec.rb
+spec/client_opinions_spec.rb

data/README.rdoc

@@ -0,0 +1,17 @@
+=whereIstand Ruby SDK
+
+The whereIstand Ruby SDK allows developers to interface with whereIstand opinion data through a series of library that encapsulates the whereIstand API service calls and adapt them into objects for your convenience.
+
+=Installation
+
+  sudo gem install whereistand
+
+=Examples
+
+  # Does an account search that returns AccountResults.
+  # Refer to source for object structure
+  results = WIS::Client::Access.account_search("bill")
+  puts "Hits: " + results.hits
+  results.accounts.each do |account|
+    puts account.name + " - " + account.description
+  end

data/lib/client/accounts.rb

@@ -0,0 +1,26 @@
+class WIS::Client::Accounts
+	
+	def self.search(string)
+		string = WIS::Client::Tools.uri_escape(string)
+		results = WIS::Client::Tools.get_json("http://api.whereistand.com/accounts?search=" + string)
+		WIS::DOM::AccountResults.adapt_json(results)
+	end
+	
+	def self.find_by_id(id)
+		WIS::DOM::Account.adapt_json(WIS::Client::Tools.get_json("http://api.whereistand.com/accounts/" + id.to_s))
+	end
+	
+	def self.find_by_id_array(ids)
+		result = WIS::Client::Tools.get_json("http://api.whereistand.com/accounts?ids=" + ids.join(","))
+		WIS::DOM::Account.adapt_json(result)
+	end
+	
+	def self.find_by_name(name)
+		WIS::DOM::Account.adapt_json(WIS::Client::Tools.get_json("http://api.whereistand.com/accounts/" + name))
+	end
+	
+	def self.find_by_name_array(names)
+		result = WIS::Client::Tools.get_json("http://api.whereistand.com/accounts?names=" + names.join(","))
+		WIS::DOM::Account.adapt_json(result)
+	end
+end

data/lib/client/issues.rb

@@ -0,0 +1,16 @@
+class WIS::Client::Issues
+	def self.search(string)
+		string = WIS::Client::Tools.uri_escape(string)
+		results = WIS::Client::Tools.get_json("http://api.whereistand.com/issues?search=" + string)
+		WIS::DOM::IssueResults.adapt_json(results)
+	end
+	
+	def self.find_by_id(id)
+		WIS::DOM::Issue.adapt_json(WIS::Client::Tools.get_json("http://api.whereistand.com/issues/" + id.to_s))
+	end
+	
+	def self.find_by_id_array(ids)
+		result = WIS::Client::Tools.get_json("http://api.whereistand.com/issues?ids=" + ids.join(","))
+		WIS::DOM::Issue.adapt_json(result)
+	end
+end

data/lib/client/opinions.rb

@@ -0,0 +1,14 @@
+class WIS::Client::Opinions
+	
+	def self.find_by_account_id_and_issue_id(account_id, issue_id)
+		results = WIS::Client::Tools.get_json("http://api.whereistand.com/opinions?account=" + account_id.to_s + "&issue=" + issue_id.to_s)
+		WIS::DOM::Opinion.adapt_json(results)
+	end
+	
+	def self.search_known_account_by_issue(account, string)
+		string = WIS::Client::Tools.uri_escape(string)
+		results = WIS::Client::Tools.get_json("http://api.whereistand.com/opinions?account=" + account.id.to_s + "&issue=" + string)
+		WIS::DOM::AccountIssues.adapt_json(results)
+	end
+	
+end

data/lib/client/tools.rb

@@ -0,0 +1,10 @@
+class WIS::Client::Tools
+	def self.get_json(url)
+		resp = Net::HTTP.get_response(URI.parse(url))
+		Yajl::Parser.parse(resp.body)
+	end
+	
+	def self.uri_escape(string)
+		URI.escape(string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+	end
+end

data/lib/dom/account.rb

@@ -1,10 +1,22 @@
 class WIS::DOM::Account
-	attr_reader :id, :name;
-	attr_accessor :description;
+	attr_reader :id, :name
+	attr_accessor :description
 			
 	def initialize(id, name, description)
-		@id = id;
-		@name = name;
-		@description = description;
+		@id = id
+		@name = name
+		@description = description
+	end
+	
+	def self.adapt_json(data)
+		if data.kind_of?(Array)
+			accounts = []
+			data.each do |a|
+				accounts << WIS::DOM::Account.new(a["ID"], a["Name"], a["Description"])
+			end
+			accounts
+		else			
+			WIS::DOM::Account.new(data["ID"], data["Name"], data["Description"])
+		end
 	end
 end

data/lib/dom/issue.rb

@@ -1,9 +1,21 @@
 class WIS::DOM::Issue
-	attr_reader :id;
-	attr_accessor :description;
+	attr_reader :id
+	attr_accessor :description
 			
 	def initialize(id, description)
-		@id = id;
-		@description = description;
+		@id = id
+		@description = description
+	end
+	
+	def self.adapt_json(data)
+		if data.kind_of?(Array)
+			issues = []
+			data.each do |i|
+				issues << WIS::DOM::Issue.new(i["ID"], i["Description"])
+			end
+			issues
+		else			
+			WIS::DOM::Issue.new(data["ID"], data["Description"])
+		end
 	end
 end

data/lib/dom/issue_results.rb

@@ -5,4 +5,13 @@ class WIS::DOM::IssueResults < WIS::DOM::Results
 		super(hits)
 		@issues = issues
 	end
+	
+	def self.adapt_json(data)
+		issues = []
+		data["Issues"].each do |i|
+			issues << WIS::DOM::Issue.new(i["ID"], i["Description"])
+		end
+		
+		WIS::DOM::IssueResults.new(data["Hits"], issues)
+	end
 end

data/lib/dom/opinion.rb

@@ -5,4 +5,10 @@ class WIS::DOM::Opinion
 		@account = account
 		@issue = issue
 	end
+	
+	def self.adapt_json(data)
+		account = WIS::DOM::Account.new(data["Account"]["ID"], data["Account"]["Name"], data["Account"]["Description"])
+		issue = WIS::DOM::Issue.new(data["Issue"]["ID"], data["Issue"]["Description"])
+		WIS::DOM::Opinion.new(account, issue)
+	end
 end

data/lib/whereistand.rb

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'uri'
+require 'net/http'
 require 'yajl'
 
 module WIS; module DOM; end; module Client; end; end
@@ -21,4 +23,7 @@ require 'dom/issue_accounts'
 require 'dom/issue_results'
 require 'dom/issue_result'
 
-require 'client/access'
+require 'client/tools'
+require 'client/accounts'
+require 'client/issues'
+require 'client/opinions'

data/spec/client_accounts_spec.rb

@@ -0,0 +1,43 @@
+require 'lib/whereistand'
+
+describe WIS::Client::Accounts do
+	
+	it "search should return results" do
+		results = WIS::Client::Accounts.search("clinton")
+		results.kind_of?(WIS::DOM::AccountResults).should be_true
+		results.hits.should > 0
+	end
+	
+	it "find by id should work" do
+		results = WIS::Client::Accounts.find_by_id(196)
+		results.should_not be_nil
+		results.kind_of?(WIS::DOM::Account).should be_true
+		results.id.should == 196
+	end
+	
+	it "find by id array should work" do
+		results = WIS::Client::Accounts.find_by_id_array([196, 5874])
+		results.should_not be_nil
+		results.length.should == 2
+		results.each do |account|
+			account.kind_of?(WIS::DOM::Account).should be_true
+		end
+	end
+	
+	it "find by name should work" do
+		results = WIS::Client::Accounts.find_by_name("brianr")
+		results.should_not be_nil
+		results.kind_of?(WIS::DOM::Account).should be_true
+		results.id.should == 196
+	end
+	
+	it "find by name array should work" do
+		results = WIS::Client::Accounts.find_by_name_array(["brianr", "nick"])
+		results.should_not be_nil
+		results.length.should == 2
+		results.each do |account|
+			account.kind_of?(WIS::DOM::Account).should be_true
+		end
+	end
+	
+end

data/spec/client_issues_spec.rb

@@ -0,0 +1,27 @@
+require 'lib/whereistand'
+
+describe WIS::Client::Issues do
+
+	it "search should return results" do
+		results = WIS::Client::Issues.search("global warming")
+		results.kind_of?(WIS::DOM::IssueResults).should be_true
+		results.hits.should > 0
+	end
+	
+	it "find by id should work" do
+		results = WIS::Client::Issues.find_by_id(16400)
+		results.should_not be_nil
+		results.kind_of?(WIS::DOM::Issue).should be_true
+		results.id.should == 16400
+	end
+	
+	it "find by id array should work" do
+		results = WIS::Client::Issues.find_by_id_array([16400, 4662])
+		results.should_not be_nil
+		results.length.should == 2
+		results.each do |issue|
+			issue.kind_of?(WIS::DOM::Issue).should be_true
+		end
+	end
+	
+end

data/spec/client_opinions_spec.rb

@@ -0,0 +1,18 @@
+require 'lib/whereistand'
+
+describe WIS::Client::Opinions do
+	
+	it "find opinion by account id and issue id should work" do
+		opinion = WIS::Client::Opinions.find_by_account_id_and_issue_id(196, 16400)
+		opinion.should_not be_nil
+		opinion.kind_of?(WIS::DOM::Opinion).should be_true
+	end
+	
+	it "known account search by issue should return results" do
+		account = WIS::DOM::Account.new(196, "brianr", "BrianR")
+		results = WIS::Client::Opinions.search_known_account_by_issue(account, "global warming")
+		results.kind_of?(WIS::DOM::AccountIssues).should be_true
+		results.hits.should > 0
+	end
+	
+end

data/whereistand.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whereistand}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["whereIstand"]
-  s.date = %q{2010-10-28}
+  s.date = %q{2010-10-30}
   s.description = %q{whereIstand Ruby SDK}
   s.email = %q{help@whereistand.com}
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib/client/access.rb", "lib/dom/account.rb", "lib/dom/account_issues.rb", "lib/dom/account_results.rb", "lib/dom/approved_opinion.rb", "lib/dom/evidenced_opinion.rb", "lib/dom/expressed_opinion.rb", "lib/dom/issue.rb", "lib/dom/issue_accounts.rb", "lib/dom/issue_result.rb", "lib/dom/issue_results.rb", "lib/dom/opinion.rb", "lib/dom/results.rb", "lib/dom/unknown_opinion.rb", "lib/dom/unverified_opinion.rb", "lib/whereistand.rb"]
-  s.files = ["CHANGELOG", "Gemfile", "Gemfile.lock", "LICENSE", "Manifest", "README", "Rakefile", "lib/client/access.rb", "lib/dom/account.rb", "lib/dom/account_issues.rb", "lib/dom/account_results.rb", "lib/dom/approved_opinion.rb", "lib/dom/evidenced_opinion.rb", "lib/dom/expressed_opinion.rb", "lib/dom/issue.rb", "lib/dom/issue_accounts.rb", "lib/dom/issue_result.rb", "lib/dom/issue_results.rb", "lib/dom/opinion.rb", "lib/dom/results.rb", "lib/dom/unknown_opinion.rb", "lib/dom/unverified_opinion.rb", "lib/whereistand.rb", "spec/client_access_spec.rb", "whereistand.gemspec"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/client/accounts.rb", "lib/client/issues.rb", "lib/client/opinions.rb", "lib/client/tools.rb", "lib/dom/account.rb", "lib/dom/account_issues.rb", "lib/dom/account_results.rb", "lib/dom/approved_opinion.rb", "lib/dom/evidenced_opinion.rb", "lib/dom/expressed_opinion.rb", "lib/dom/issue.rb", "lib/dom/issue_accounts.rb", "lib/dom/issue_result.rb", "lib/dom/issue_results.rb", "lib/dom/opinion.rb", "lib/dom/results.rb", "lib/dom/unknown_opinion.rb", "lib/dom/unverified_opinion.rb", "lib/whereistand.rb"]
+  s.files = ["CHANGELOG", "Gemfile", "Gemfile.lock", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "lib/client/accounts.rb", "lib/client/issues.rb", "lib/client/opinions.rb", "lib/client/tools.rb", "lib/dom/account.rb", "lib/dom/account_issues.rb", "lib/dom/account_results.rb", "lib/dom/approved_opinion.rb", "lib/dom/evidenced_opinion.rb", "lib/dom/expressed_opinion.rb", "lib/dom/issue.rb", "lib/dom/issue_accounts.rb", "lib/dom/issue_result.rb", "lib/dom/issue_results.rb", "lib/dom/opinion.rb", "lib/dom/results.rb", "lib/dom/unknown_opinion.rb", "lib/dom/unverified_opinion.rb", "lib/whereistand.rb", "spec/client_accounts_spec.rb", "spec/client_issues_spec.rb", "spec/client_opinions_spec.rb", "whereistand.gemspec"]
   s.homepage = %q{http://github.com/whereIstand/ruby-sdk}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Whereistand", "--main", "README"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Whereistand", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{whereistand}
   s.rubygems_version = %q{1.3.7}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whereistand
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - whereIstand
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-28 00:00:00 -04:00
+date: 2010-10-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,8 +69,11 @@ extensions: []
 extra_rdoc_files: 
 - CHANGELOG
 - LICENSE
-- README
-- lib/client/access.rb
+- README.rdoc
+- lib/client/accounts.rb
+- lib/client/issues.rb
+- lib/client/opinions.rb
+- lib/client/tools.rb
 - lib/dom/account.rb
 - lib/dom/account_issues.rb
 - lib/dom/account_results.rb
@@ -92,9 +95,12 @@ files:
 - Gemfile.lock
 - LICENSE
 - Manifest
-- README
+- README.rdoc
 - Rakefile
-- lib/client/access.rb
+- lib/client/accounts.rb
+- lib/client/issues.rb
+- lib/client/opinions.rb
+- lib/client/tools.rb
 - lib/dom/account.rb
 - lib/dom/account_issues.rb
 - lib/dom/account_results.rb
@@ -110,7 +116,9 @@ files:
 - lib/dom/unknown_opinion.rb
 - lib/dom/unverified_opinion.rb
 - lib/whereistand.rb
-- spec/client_access_spec.rb
+- spec/client_accounts_spec.rb
+- spec/client_issues_spec.rb
+- spec/client_opinions_spec.rb
 - whereistand.gemspec
 has_rdoc: true
 homepage: http://github.com/whereIstand/ruby-sdk
@@ -123,7 +131,7 @@ rdoc_options:
 - --title
 - Whereistand
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/lib/client/access.rb

@@ -1,13 +0,0 @@
-class WIS::Client::Access
-	
-	def self.account_search(string)
-		# invoke call to http://api.whereistand.com/account/search?q=blah 
-		value = "{\"Accounts\":[{\"ID\":380,\"Name\":\"BillClinton\",\"Description\":\"Bill Clinton\"},{\"ID\":120,\"Name\":\"HillaryClinton\",\"Description\":\"Hillary Rodham Clinton\"},{\"ID\":3340,\"Name\":\"ChelseaClinton\",\"Description\":\"Chelsea Clinton\"}],\"Hits\":3}"
-		WIS::DOM::AccountResults.adapt_json(Yajl::Parser.parse(value))
-	end
-	
-	def self.account_issues_search(account, string)
-		value = "{\"Account\":{\"ID\":1,\"Name\":\"BillClinton\",\"Description\":\"William Jefferson Clinton\"},\"Issues\":[{\"Issue\":{\"ID\":1,\"Description\":\"Is global warming cool?\"},\"Unknown\":null,\"Unverified\":null,\"Approved\":{\"Account\":{\"ID\":1,\"Name\":\"BillClinton\",\"Description\":\"William Jefferson Clinton\"},\"Issue\":{\"ID\":1,\"Description\":\"Is global warming cool?\"}}},{\"Issue\":{\"ID\":2,\"Description\":\"Is global warming awesome?\"},\"Unknown\":{\"Account\":null,\"Issue\":{\"ID\":2,\"Description\":\"Is global warming awesome?\"}},\"Unverified\":null,\"Approved\":null},{\"Issue\":{\"ID\":3,\"Description\":\"Is global warming raspy?\"},\"Unknown\":{\"Account\":null,\"Issue\":{\"ID\":3,\"Description\":\"Is global warming raspy?\"}},\"Unverified\":null,\"Approved\":null}],\"Hits\":3}"
-		WIS::DOM::AccountIssues.adapt_json(Yajl::Parser.parse(value))
-	end
-end

data/spec/client_access_spec.rb

@@ -1,20 +0,0 @@
-require 'lib/whereistand'
-
-describe WIS::Client::Access do
-	
-	it "account search should not fail" do
-		WIS::Client::Access.account_search("bill clinton")
-	end
-	
-	it "account issues search should not fail" do
-		account = WIS::DOM::Account.new(1, "BillClinton", "Bill Clinton")
-		WIS::Client::Access.account_issues_search(account, "global warming")
-	end
-	
-	it "should do this just for me" do
-		Dir["**/*"].select do |d|
-			puts d
-		end
-	end
-	
-end