the-city-admin 0.1.4 → 0.1.5

data/lib/readers/user_admin_privilege_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       user_id = options[:user_id]    
-      @class_key = "users_#{user_id}_admin_privileges_#{page}"   
+      #@class_key = "users_#{user_id}_admin_privileges_#{page}"   
       @url_data_path = "/users/#{user_id}/admin_privileges"
       @url_data_params = {:page => page}
       

data/lib/readers/user_count_reader.rb

@@ -16,7 +16,7 @@ module TheCity
     #
     #   UserCount.new({:filter => :created_in_the_last_7_Days})
     def initialize(options = {}, cacher = nil)
-      @class_key = "users_count_#{options[:filter] || ''}"   
+      #@class_key = "users_count_#{options[:filter] || ''}"   
       @url_data_path = "/users/count"
 
       @url_data_params = {:filter => options[:filter] || ''}    

data/lib/readers/user_family_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       user_id = options[:user_id]
-      @class_key = "users_#{user_id}_family"   
+      #@class_key = "users_#{user_id}_family"   
       @url_data_path = "/users/#{user_id}/family"
       
       # The object to store and load the cache.

data/lib/readers/user_invitation_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       user_id = options[:user_id]
-      @class_key = "users_#{user_id}_invitations_#{page}"   
+      #@class_key = "users_#{user_id}_invitations_#{page}"   
       @url_data_path = "/users/#{user_id}/invitations"
       @url_data_params = {:page => page}
       

data/lib/readers/user_list_reader.rb

@@ -11,7 +11,7 @@ module TheCity
       page = options[:page] || 1
       filter = options[:filter] 
 
-      @class_key = "user_list_#{page}_#{filter.to_s.downcase.gsub(' ','')}"   
+      #@class_key = "user_list_#{page}_#{filter.to_s.downcase.gsub(' ','')}"   
       @url_data_path = "/users"
       @url_data_params = {:page => page}
       @url_data_params.merge!({:filter => filter}) if filter

data/lib/readers/user_note_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       user_id = options[:user_id]
-      @class_key = "users_#{user_id}_notes_#{page}"   
+      #@class_key = "users_#{user_id}_notes_#{page}"   
       @url_data_path = "/users/#{user_id}/notes"
       @url_data_params = {:page => page}
       

data/lib/readers/user_process_answer_list_reader.rb

@@ -0,0 +1,24 @@
+module TheCity
+
+  class UserProcessAnswerListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: user_id and process_id are required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil)
+      page = options[:page] || 1
+      user_id = options[:user_id]
+      process_id = options[:process_id]
+      #@class_key = "users_#{user_id}_processes_#{page}"
+      @url_data_path = "/users/#{user_id}/processes/#{process_id}/answers"
+      @url_data_params = {:page => page}
+
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?
+    end
+
+  end
+
+end

data/lib/readers/user_process_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       user_id = options[:user_id]
-      @class_key = "users_#{user_id}_processes_#{page}"   
+      #@class_key = "users_#{user_id}_processes_#{page}"   
       @url_data_path = "/users/#{user_id}/processes"
       @url_data_params = {:page => page}
       

data/lib/readers/user_reader.rb

@@ -9,7 +9,7 @@ module TheCity
     #                           'include_custom_fields' => true/false.  Default is false.
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(user_id, options = {}, cacher = nil)
-      @class_key = "users_#{user_id}"   
+      #@class_key = "users_#{user_id}"   
       @url_data_path = "/users/#{user_id}"
       @url_data_params = {:include_custom_fields => true}
       

data/lib/readers/user_role_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       user_id = options[:user_id]
-      @class_key = "users_#{user_id}_roles_#{page}"   
+      #@class_key = "users_#{user_id}_roles_#{page}"   
       @url_data_path = "/users/#{user_id}/roles"
       @url_data_params = {:page => page}
       

data/lib/readers/user_skill_list_reader.rb

@@ -10,7 +10,7 @@ module TheCity
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
       user_id = options[:user_id]
-      @class_key = "users_#{user_id}_skills_#{page}"   
+      #@class_key = "users_#{user_id}_skills_#{page}"   
       @url_data_path = "/users/#{user_id}/skills"
       @url_data_params = {:page => page}
       

data/lib/readers/web_hook_list_reader.rb

@@ -8,7 +8,7 @@ module TheCity
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
       page = options[:page] || 1
-      @class_key = "web_hooks_#{page}"   
+      #@class_key = "web_hooks_#{page}"   
       @url_data_path = "/webhooks"
       @url_data_params = {:page => page}
       

data/spec/api/user_process_answer_list_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe 'UserProcessAnswerList' do
+
+  before do
+    simulate_connection_to_server
+  end
+
+  after do
+  end
+
+  it 'should pass if user process answer list attribute is not specified' do
+    user_id = process_id = 123
+    request_data = FactoryGirl.attributes_for(:user_process_answer_list, {
+      :total_entries => 1,
+      :total_pages => 1,
+      :answers => [FactoryGirl.attributes_for(:user_process_answer)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    answer_list = TheCity::UserProcessAnswerList.new({:user_id => user_id, :process_id => process_id})
+
+    answer = answer_list[0]
+    answer.question_id.should == 316
+    answer.question.should == "Do you like foo?"
+    answer.answer.should == "bar"
+    answer.answered_at.should == Time.now.to_date.to_s
+  end
+
+
+  it 'should pass if user process answer list is empty' do
+    user_id = process_id = 123
+    request_data = FactoryGirl.attributes_for(:user_process_answer_list, {
+      :total_entries => 1,
+      :total_pages => 1,
+      :answers => []
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    answer_list = TheCity::UserProcessAnswerList.new({:user_id => user_id, :process_id => process_id})
+
+    answer_list.empty?.should be_true
+  end
+
+
+  it 'should return a valid list of user process answers' do
+    user_id = process_id = 123
+    page = 2
+    request_data = FactoryGirl.attributes_for(:user_process_answer_list, {
+      :total_entries => 1,
+      :total_pages => 1,
+      :current_page => 2,
+      :answers => [FactoryGirl.attributes_for(:user_process_answer)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    answer_list = TheCity::UserProcessAnswerList.new({:user_id => user_id, :page => page})
+    answer_list.current_page.should == 2
+    answer_list.empty?.should be_false
+
+    answer = answer_list[0]
+    answer.question.should == "Do you like foo?"
+  end
+
+
+  it 'should iterate using *each* method' do
+    user_id = process_id = 123
+    request_data = FactoryGirl.attributes_for(:user_process_answer_list, {
+      :total_entries => 1,
+      :total_pages => 1,
+      :answers => [FactoryGirl.attributes_for(:user_process_answer)]
+    }).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    answer_list = TheCity::UserProcessAnswerList.new({:user_id => user_id})
+
+    answers = answer_list.map(&:answer)
+    answers.should == %w(bar)
+  end
+
+
+  it 'should iterate using *collect* method' do
+    # redundant test, we can trust Enumerable to do its thang
+  end
+
+end
+
+

data/spec/factories/user_process_answer.rb

@@ -0,0 +1,13 @@
+module TheCity
+  FactoryGirl.define do
+
+    factory :user_process_answer, :class => TheCity::UserProcessAnswer do
+      question_id 316
+      question "Do you like foo?"
+      answer "bar"
+      answered_at Date.today
+      required true
+    end
+
+  end
+end

data/spec/factories/user_process_answer_list.rb

@@ -0,0 +1,12 @@
+module TheCity
+  FactoryGirl.define do
+
+    factory :user_process_answer_list, :class => TheCity::UserProcessAnswerList do
+      total_entries 0
+      total_pages 0
+      per_page 15
+      current_page 1
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -12,6 +12,7 @@ require File.expand_path( File.dirname(__FILE__) + '/../lib/the_city_admin.rb')
 require 'rubygems'
 require 'rspec'
 require 'ruby-debug'
+require 'date'
 
 require 'factory_girl'
 Dir.glob(File.dirname(__FILE__) + "/factories/*").each { |f| require f }

data/thecity_admin_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   PROJECT_GEM = 'the-city-admin'
-  PROJECT_GEM_VERSION = '0.1.4'
+  PROJECT_GEM_VERSION = '0.1.5'
   
   s.name = PROJECT_GEM
   s.version = PROJECT_GEM_VERSION
@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   s.authors = ['Wes Hays']
   s.email = 'wes@onthecity.org'
 
-  s.summary = 'Ruby gem/plugin to interact with The City Admin API (http://api.OnTheCity.org).'
-  s.description = 'Ruby gem/plugin to interact with The City Admin API (http://api.OnTheCity.org).'
+  s.summary = 'Ruby gem/plugin to interact with The City Admin API (https://api.OnTheCity.org).'
+  s.description = 'Ruby gem/plugin to interact with The City Admin API (https://api.OnTheCity.org). Checkout the project on github for more detail.'
 
   s.add_dependency('typhoeus')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the-city-admin
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-01 00:00:00.000000000 Z
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -27,7 +27,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Ruby gem/plugin to interact with The City Admin API (http://api.OnTheCity.org).
+description: Ruby gem/plugin to interact with The City Admin API (https://api.OnTheCity.org).
+  Checkout the project on github for more detail.
 email: wes@onthecity.org
 executables: []
 extensions: []
@@ -43,8 +44,21 @@ files:
 - .yardoc/proxy_types
 - Gemfile
 - Gemfile.lock
-- README
+- README.rdoc
 - Rakefile
+- examples/addresses.rb
+- examples/barcodes_checkins.rb
+- examples/city_keys.rb
+- examples/familes.rb
+- examples/groups.rb
+- examples/metrics.rb
+- examples/roles.rb
+- examples/skills.rb
+- examples/tags.rb
+- examples/terminology.rb
+- examples/thecity_headers.rb
+- examples/users.rb
+- examples/webhooks.rb
 - index.rb
 - lib/api/address.rb
 - lib/api/address_list.rb
@@ -74,6 +88,8 @@ files:
 - lib/api/metric_list.rb
 - lib/api/metric_measurement.rb
 - lib/api/metric_measurement_list.rb
+- lib/api/pledge.rb
+- lib/api/pledge_list.rb
 - lib/api/role.rb
 - lib/api/role_list.rb
 - lib/api/skill.rb
@@ -100,6 +116,8 @@ files:
 - lib/api/user_note.rb
 - lib/api/user_note_list.rb
 - lib/api/user_process.rb
+- lib/api/user_process_answer.rb
+- lib/api/user_process_answer_list.rb
 - lib/api/user_process_list.rb
 - lib/api/user_role.rb
 - lib/api/user_role_list.rb
@@ -131,6 +149,8 @@ files:
 - lib/readers/metric_measurement_list_reader.rb
 - lib/readers/metric_measurement_reader.rb
 - lib/readers/metric_reader.rb
+- lib/readers/pledge_list_reader.rb
+- lib/readers/pledge_reader.rb
 - lib/readers/role_list_reader.rb
 - lib/readers/skill_list_reader.rb
 - lib/readers/skilled_user_id_list_reader.rb
@@ -147,6 +167,7 @@ files:
 - lib/readers/user_invitation_list_reader.rb
 - lib/readers/user_list_reader.rb
 - lib/readers/user_note_list_reader.rb
+- lib/readers/user_process_answer_list_reader.rb
 - lib/readers/user_process_list_reader.rb
 - lib/readers/user_reader.rb
 - lib/readers/user_role_list_reader.rb
@@ -170,7 +191,6 @@ files:
 - lib/writers/user_skill_writer.rb
 - lib/writers/user_writer.rb
 - lib/writers/web_hook_writer.rb
-- notes.txt
 - spec/api/address_list_spec.rb
 - spec/api/address_spec.rb
 - spec/api/group_address_list_spec.rb
@@ -212,6 +232,7 @@ files:
 - spec/api/user_list_spec.rb
 - spec/api/user_note_list_spec.rb
 - spec/api/user_note_spec.rb
+- spec/api/user_process_answer_list_spec.rb
 - spec/api/user_process_list_spec.rb
 - spec/api/user_process_spec.rb
 - spec/api/user_role_list_spec.rb
@@ -261,6 +282,8 @@ files:
 - spec/factories/user_note.rb
 - spec/factories/user_note_list.rb
 - spec/factories/user_process.rb
+- spec/factories/user_process_answer.rb
+- spec/factories/user_process_answer_list.rb
 - spec/factories/user_process_list.rb
 - spec/factories/user_role.rb
 - spec/factories/user_role_list.rb
@@ -274,21 +297,7 @@ files:
 - spec/writers/skill_writer_spec.rb
 - spec/writers/tag_writer_spec.rb
 - spec/writers/user_writer_spec.rb
-- status.txt
-- test_scripts/addresses.rb
-- test_scripts/barcodes_checkins.rb
-- test_scripts/city_keys.rb
-- test_scripts/familes.rb
-- test_scripts/groups.rb
-- test_scripts/metrics.rb
-- test_scripts/roles.rb
-- test_scripts/skills.rb
-- test_scripts/tags.rb
-- test_scripts/terminology.rb
-- test_scripts/users.rb
-- test_scripts/webhooks.rb
 - thecity_admin_api.gemspec
-- thecity_headers.rb
 homepage: https://github.com/thecity/thecity-admin-ruby
 licenses: []
 post_install_message: 
@@ -312,7 +321,7 @@ rubyforge_project: Project on www.github.com
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Ruby gem/plugin to interact with The City Admin API (http://api.OnTheCity.org).
+summary: Ruby gem/plugin to interact with The City Admin API (https://api.OnTheCity.org).
 test_files:
 - spec/api/address_list_spec.rb
 - spec/api/address_spec.rb
@@ -355,6 +364,7 @@ test_files:
 - spec/api/user_list_spec.rb
 - spec/api/user_note_list_spec.rb
 - spec/api/user_note_spec.rb
+- spec/api/user_process_answer_list_spec.rb
 - spec/api/user_process_list_spec.rb
 - spec/api/user_process_spec.rb
 - spec/api/user_role_list_spec.rb
@@ -404,6 +414,8 @@ test_files:
 - spec/factories/user_note.rb
 - spec/factories/user_note_list.rb
 - spec/factories/user_process.rb
+- spec/factories/user_process_answer.rb
+- spec/factories/user_process_answer_list.rb
 - spec/factories/user_process_list.rb
 - spec/factories/user_role.rb
 - spec/factories/user_role_list.rb

data/README

@@ -1 +0,0 @@
-This Ruby project is an API wrapper for TheCity Admin API (OnTheCity.org)

data/notes.txt

@@ -1,21 +0,0 @@
-UserList
-  - initialize
-  - attributes...
-  - Operations (ex. next_page returns the next UserList object)
-  - Users
-  - Load data
-    - URL
-    - Cache
-      - File (JSON)
-      - Database
-      - Memcache
-
-User
-  - attributes...
-  - Crud operations
-  - Load data
-    - URL
-    - Cache
-      - File (JSON)
-      - Database
-      - Memcache