the-city-admin 0.1.0 → 0.1.1

data/spec/functional/the_city_admin_spec.rb

@@ -0,0 +1,20 @@
+require File.join(Dir.pwd, 'spec', 'spec_helper')
+
+describe 'AdminApi' do
+
+  before do
+    simulate_connection_to_server
+  end
+
+  after do
+
+  end
+
+  it 'should get a list of users without any paramters'
+  it 'should get a list of users with parameters'
+  it 'should get a user count without any paramters'
+  it 'should get a user count with the specified paramters'
+
+end
+
+

data/spec/readers/user_reader_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'UserReader' do
+  
+  it 'should pass if ....' 
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+# Project::    TheCity Admin API 
+# File::       the_city.rb
+#
+# Author:: Wes Hays <weshays@gbdev.com> 
+# Link:: https://github.com/weshays/admin-api-ruby
+# Version:: 0.1a
+# Package:: TheCity::Admin
+
+
+require File.expand_path( File.dirname(__FILE__) + '/../lib/the_city_admin.rb')
+
+require 'rubygems'
+require 'rspec'
+require 'ruby-debug'
+
+require 'factory_girl'
+Dir.glob(File.dirname(__FILE__) + "/factories/*").each { |f| require f }
+
+
+TheCityResponse = Struct.new(:code, :body)
+
+RSpec.configure do |config|
+  config.tty = true
+  config.mock_with :rspec
+  config.include FactoryGirl::Syntax::Methods
+end
+
+
+def simulate_connection_to_server
+  @the_city = TheCity::AdminApi.new('cf2903151e3213e66fd8080c7d8b65b1d6ccdd31', '5c88b32edda7653c')
+end

data/spec/writers/tag_writer_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe 'TagWriter' do
+
+  it 'should show connection error messages if server cannot be reached' do
+    TheCity.stub(:admin_request) { raise TheCityExceptions::UnableToConnectToTheCity.new('Unable to connect to server') }
+    tag_data = {:name => 'Cool People'}
+    tag = TheCity::Tag.new(tag_data)
+    tag.id.should be_nil
+    tag.save.should === false
+    tag.id.should be_nil
+    tag.error_messages.should == ['Unable to connect to server']
+  end  
+
+
+  it 'should save if all data is valid for new tag' do
+    request_data = FactoryGirl.attributes_for(:tag, {:id => 12345}).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    tag_data = {:name => 'Cool People'}
+    tag = TheCity::Tag.new(tag_data)
+    tag.id.should be_nil
+    tag.save.should === true
+    tag.id.should == 12345
+  end
+
+
+  it 'should show error messages if save fails for new tag' do
+    TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('tag already exists') }
+    tag_data = {:name => 'Cool People'}
+    tag = TheCity::Tag.new(tag_data)
+    tag.id.should be_nil
+    tag.save.should === false
+    tag.id.should be_nil
+    tag.error_messages.should == ['tag already exists']
+  end  
+
+
+  it 'should save if all data is valid for existing tag' do
+    request_data = FactoryGirl.attributes_for(:tag, {:id => 12345}).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    tag_data = FactoryGirl.attributes_for(:tag, {:id => 12345})
+    tag = TheCity::Tag.new(tag_data)
+    tag.id.should == 12345
+    tag.save.should === true
+    tag.id.should == 12345
+  end
+
+
+  it 'should show error messages if save fails for existing tag' do
+    TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('something bad happened') }
+    tag_data = FactoryGirl.attributes_for(:tag, {:id => 12345})
+    tag = TheCity::Tag.new(tag_data)
+    tag.id.should == 12345
+    tag.save.should === false
+    tag.id.should == 12345
+    tag.error_messages.should == ['something bad happened']
+  end  
+
+
+  it 'should delete if data ID exists for the existing tag' do
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(204, '{}') )
+    tag_data = FactoryGirl.attributes_for(:tag, {:id => 12345})
+    tag = TheCity::Tag.new(tag_data)
+    tag.is_deleted?.should === false
+    tag.delete
+    tag.is_deleted?.should === true
+  end
+
+
+  it 'should show error messages if data fails to be deleted' do
+    TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('something bad happened') }
+    tag_data = FactoryGirl.attributes_for(:tag, {:id => 12345})
+    tag = TheCity::Tag.new(tag_data)
+    tag.is_deleted?.should === false
+    tag.delete
+    tag.is_deleted?.should === false
+    tag.error_messages.should == ['something bad happened']
+  end  
+
+end

data/spec/writers/user_writer_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe 'UserWriter' do
+
+  it 'should show connection error messages if server cannot be reached' do
+    TheCity.stub(:admin_request) { raise TheCityExceptions::UnableToConnectToTheCity.new('Unable to connect to server') }
+    user_data = FactoryGirl.attributes_for(:user, {:id => nil})
+    user = TheCity::User.new(user_data)
+    user.id.should be_nil
+    user.save.should === false
+    user.id.should be_nil
+    user.error_messages.should == ['Unable to connect to server']
+  end  
+
+
+  it 'should save if all data is valid for new user' do
+    request_data = FactoryGirl.attributes_for(:user, {:id => 12345}).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )
+    user_data = FactoryGirl.attributes_for(:user, {:id => nil})
+    user = TheCity::User.new(user_data)
+    user.id.should be_nil
+    user.save.should === true
+    user.id.should == 12345
+  end
+
+
+  it 'should show error messages if save fails for new user' do
+    TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('email address already exists') }
+    user_data = FactoryGirl.attributes_for(:user, {:id => nil})
+    user = TheCity::User.new(user_data)
+    user.id.should be_nil
+    user.save.should === false
+    user.id.should be_nil
+    user.error_messages.should == ['email address already exists']
+  end  
+
+
+  it 'should save if all data is valid for existing user' do
+    request_data = FactoryGirl.attributes_for(:user, {:id => 12345}).to_json
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(200, request_data) )    
+    user_data = FactoryGirl.attributes_for(:user, {:id => 12345})
+    user = TheCity::User.new(user_data)
+    user.id.should == 12345
+    user.save.should === true
+    user.id.should == 12345
+  end
+
+
+  it 'should show error messages if save fails for existing user' do
+    TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('something bad happened') }
+    user_data = FactoryGirl.attributes_for(:user, {:id => 12345})
+    user = TheCity::User.new(user_data)
+    user.id.should == 12345
+    user.save.should === false
+    user.id.should == 12345
+    user.error_messages.should == ['something bad happened']
+  end  
+
+
+  it 'should delete if data ID exists for the existing user' do
+    TheCity.stub(:admin_request).and_return( TheCityResponse.new(204, '{}') ) 
+    user_data = FactoryGirl.attributes_for(:user, {:id => 12345})
+    user = TheCity::User.new(user_data)
+    user.is_deleted?.should === false
+    user.delete
+    user.is_deleted?.should === true
+  end
+
+
+  it 'should show error messages if data fails to be deleted' do
+    TheCity.stub(:admin_request) { raise TheCityExceptions::TheCityResponseError.new('something bad happened') }
+    user_data = FactoryGirl.attributes_for(:user, {:id => 12345})
+    user = TheCity::User.new(user_data)
+    user.is_deleted?.should === false
+    user.delete
+    user.is_deleted?.should === false
+    user.error_messages.should == ['something bad happened']
+  end  
+
+end

data/status.txt

@@ -0,0 +1,187 @@
+Items with a "+" in front are done.
+Items with a "-" in front are almost done.
+
+
+## User Endpoints ##
++Users Index
++Users Show
++Users Create
++Users Update
++Users Destroy
++Users Count
+Users Memberize
+Users Dememberize
+Users Deactivate
+Users Bulk Memberize
+Users Bulk Deactivate
++Users Addresses Index
++Users Addresses Show
++Users Addresses Create
++Users Addresses Update
++Users Addresses Destroy
++Users Admin Privileges Index
++Users Admin Privileges Create
+Users Barcodes Index
+Users Barcodes Show
+Users Barcodes Create
+Users Barcodes Destroy
+Users Checkins Index
+Users Checkins Show
+Users Checkins Last
+Users Event Attendances Index
+Users Event Attendances Show
+Users Event Attendances Recent
+Users Event Attendances Dates
++Users Invitations Index
++Users Invitations Create
++Users Family Index
+Users Family Create
+Users Family Update
+Users Family Destroy
++Users Notes Index
++Users Notes Show
++Users Notes Create
++Users Processes Index
+Users Processes Show
+Users Processes Answers Index
+Users Processes Notes Index
++Users Roles Index
++Users Roles Show
++Users Roles Create
++Users Roles Destroy
+Users Roles Activate
+Users Roles Deactivate
+Users Roles Promote
+Users Roles Demote
++Users Skills Index
++Users Skills Create
++Users Skills Destroy
+
+
+## Group Endpoints ##
++Groups Index
++Groups Show
++Groups Create
++Groups Update
+Groups Count
+Groups Schedule Archive
+Groups Schedule Deletion
+Groups Undo Scheduled Archive
+Groups Undo Scheduled Deletion
+Groups Unarchive
++Groups Addresses Index
++Groups Addresses Show
++Groups Addresses Create
++Groups Addresses Update
++Groups Addresses Destroy
++Groups Checkins Index
+Groups Checkins Show
+Groups Event Attendances Index
+Groups Event Attendances Show
++Groups Exports Index
+Groups Exports Show
+Groups Exports Create
+Groups Health Assessments Index
++Groups Invitations Index
+Groups Invitations Create
++Groups Roles Index
+Groups Roles Show
+Groups Roles Create
+Groups Roles Destroy
+Groups Roles Activate
+Groups Roles Deactivate
+Groups Roles Promote
+Groups Roles Demote
+Groups Roles Deactivate All
++Groups Tags Index
++Groups Tags Create
++Groups Tags Destroy
+
+
+## Address Endpoints ##
++Addresses Index
++Addresses Show
+Addresses Groups
+
+
+## Barcode Endpoints ##
++Barcodes Show
+
+## Checkin Endpoints ##
+Checkins Index
+Checkins Show
+Checkins By Barcode
+Checkins By Callboard Number
+Checkins By Pager Number
+Checkins By Parent Receipt Barcode
+
+
+##Custom Field Endpoints ##
+Custom Fields Index
+Custom Fields Show
+Custom Fields Create
+Custom Fields Update
+Custom Fields Destroy
+Custom Fields Users Index
+Custom Fields Users Count
+
+
+## Family Endpoints ##
+Families Show
+Families Create
+Families Update
+Families Destroy
+
+
+## Invitation Endpoints ##
+Invitations Index
+Invitations Bulk Invite
+
+
+## Metric Endpoints ##
++Metrics Index
++Metrics Show
++Metrics Create
++Metrics Update
++Metrics Destroy
+Metrics Measurements Index
+Metrics Measurements Show
+Metrics Measurements Create
+Metrics Measurements Update
+Metrics Measurements Destroy
+Metrics Measurements Last
+Metrics Measurements Values
+
+
+## Role Endpoints ##
++Roles Index
+
+
+## Skill Endpoints ##
++Skills Index
++Skills Show
++Skills Create
++Skills Destroy
+Skills Users Index
+Skills User Ids
+
+
+## Tag Endpoints ##
++Tags Index
++Tags Show
++Tags Create
++Tags Update
++Tags Destroy
+Tags Groups Index
+
+
+## Terminology Endpoints ##
++Terminology Index
++Terminology Show
++Terminology Update
+
+
+## WebHook Endpoints ##
++WebHooks Index
++WebHooks Create
++WebHooks Destroy

data/test_scripts/addresses.rb

@@ -0,0 +1,36 @@
+# *******************************************
+# This is a demo file to show usage.
+#
+# @package TheCity::Admin
+# @authors Robbie Lieb <robbie@onthecity.org>, Wes Hays <wes@onthecity.org>
+# ******************************************* 
+
+require 'ruby-debug'
+require File.dirname(__FILE__) + '/../lib/the_city_admin.rb'
+
+require File.dirname(__FILE__) + '/city_keys.rb'
+include CityKeys
+
+TheCity::AdminApi.connect(KEY, TOKEN)
+
+
+puts "------------------------------------"
+
+address_list = TheCity::AddressList.new
+if address_list.empty?
+  puts "No addresses in list"
+else
+  puts "Addresss: #{address_list.count}"
+end
+
+address = address_list[0]
+
+address2 = TheCity::Address.load_by_id(address.id)
+
+if address2.street == address.street
+  puts "Address found (#{address.street})"
+else
+  puts "Failed to load address"
+end
+
+puts "####################################"