the-city-admin 0.1.0 → 0.1.1

data/.autotest

@@ -0,0 +1,9 @@
+Autotest.add_hook(:initialize) {|at|
+  at.add_exception %r{^\.git}  # ignore Version Control System
+  at.add_exception %r{^./tmp}  # ignore temp files, lest autotest will run again, and again...
+  #  at.clear_mappings         # take out the default (test/test*rb)
+  at.add_mapping(%r{^lib/.*\.rb$}) {|f, _|
+    Dir['spec/**/*.rb']
+  }
+  nil
+}

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+storage/*
+doc/*
+the-city-admin-*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p290@admin-api

data/.yardoc/checksums

@@ -0,0 +1,50 @@
+lib/api/user.rb 5dade14583140e58467fe81ec6d9dcd8cb7ce771
+lib/api/group.rb 688af7befcf3625562a4aef1dc504acb3ceab9a5
+lib/api/user_list.rb f44fbcb17b7bd5af0c8badc962cc002eb1515b1a
+lib/api/user_note.rb 7eab928ca4fd289d173da2328d1287bcc8e0ec86
+lib/api/user_role.rb 6c94d6554127bd5ba7dd8fa5a1d8050e69a79762
+lib/api/group_tag.rb 9cf763bb34b213c693607b29da52ea1f3ea8ab43
+lib/api/api_object.rb f9bd763bcac5924f26aabcaf031db815327781e3
+lib/api/group_role.rb 00f19d0474379a62eea84497de5061d66a7865a6
+lib/api/group_list.rb 0e735c638cf75d927a992d45d3a9bd8d2c6a847c
+lib/api/user_skill.rb 8ea23049d38ea56a58e931a1f25c02115d176522
+lib/api/user_process.rb 2248b5aac1a9777669d0884296ae00fbed3a0cbe
+lib/savers/api_saver.rb 84647040fa91876aede6c7fd96852d90673cbc0e
+lib/api/user_address.rb 0e0aee03c01396688a613dd25d0e9bfe2ab62568
+lib/api/group_address.rb 0e0aee03c01396688a613dd25d0e9bfe2ab62568
+lib/savers/user_saver.rb bfeb601f57cbe388c36a7fe6fb11211a1fb2d929
+lib/api/group_tag_list.rb 3176b69b88ab4d57ab0055a96a79d6e4f652220d
+lib/savers/group_saver.rb 02f37545a177d9a7e750672d271e246bb323d028
+lib/loaders/api_loader.rb 7610bcecd9a4ef7d26cb798e7020b42fa678a47a
+lib/api/user_role_list.rb 6a145e707f6983de15bed5e4f68d3ef4b4f3a441
+lib/api/user_note_list.rb 68b9a7891cac8c1b65bdddfa4f34b63fe00c73a4
+lib/api/user_skill_list.rb 3dcae8a035930c13dc94c9486fcd954877babd69
+lib/loaders/user_loader.rb 81063767128f7531b09b184c36bcbeae2ae4fdc0
+lib/api/group_role_list.rb ebfc563a4a515598eaa7cfaf100b05b8d6db5125
+lib/api/user_invitation.rb 2795c3fb3149560e3dcd69dba6a05034150fe76b
+lib/api/user_family_list.rb f01ea5f60815860074b0e0cbcbe6fc745f346326
+lib/api/group_invitation.rb 6185ab5951831992988996fb00953b956df5d560
+lib/loaders/group_loader.rb 4c12f649c547633ad94616a4ae5cc8c1de6fe13c
+lib/cachers/cache_adapter.rb b05d6e2d541c09245e515ef55228cbcdcbfce049
+lib/api/user_address_list.rb 2d39275605b855509918fdb3320c93ae618dc96a
+lib/api/user_process_list.rb e2f4fb3a792253a7a0857b07af90155d84676d55
+lib/api/group_address_list.rb d3bceba9f2f0ad1c576d9dc43e02064f5eadc16f
+lib/api/user_family_member.rb e45c848b782a3267b90001e530115d006cbb543c
+lib/loaders/user_list_loader.rb 82ae7ec17a0dfaefb5d475a09c5aa28cb793eefc
+lib/api/user_invitation_list.rb 0f5de9a0c65ec3cdb712a1b822d4fa6c7bdff142
+lib/api/user_admin_privilege.rb c44d44c7f5aecbc397b83b6c7daba310cee08b87
+lib/api/group_invitation_list.rb c64c56679a79b5bf2ce8d17b811a18d4617c5cbd
+lib/loaders/group_list_loader.rb 1b1d7d5eda23bee37bfe2d4204d1399e11ffda7a
+lib/loaders/user_role_list_loader.rb eaf1e78c3947f7eb80d0dde2e5237025f610ad2f
+lib/loaders/user_note_list_loader.rb 59e861cbaf5536e0851f4be181a629acd2621937
+lib/loaders/group_tag_list_loader.rb 2b17f2af70ed7a1e9e45657f45f2e5fd75657404
+lib/api/user_admin_privilege_list.rb 7c954ccdd8b9e4d270ded17c253d23b4fd7a9f28
+lib/loaders/user_skill_list_loader.rb db64c1cffac257fbde2ff6b9a236a7170e58cba1
+lib/loaders/group_role_list_loader.rb f49af8592fc34fc59c155bddbb7f188c3f956979
+lib/loaders/user_family_list_loader.rb dc5336a91f6f7b061f362d682edeebacb0bcac76
+lib/loaders/user_process_list_loader.rb 656704758d8369d6391865172a56afa40d3ddc06
+lib/loaders/user_address_list_loader.rb 43d91cf3866e6cfad97339325e36065c5db6cf52
+lib/loaders/group_address_list_loader.rb 1b6e628a464d345bdb8beb1cbc5570d3104eeaf6
+lib/loaders/user_invitation_list_loader.rb dfa2590f8d1a122a34d147a38be9c6bf21927c57
+lib/loaders/group_invitation_list_loader.rb 81c117073f3f950f8aca7b05ba6b596e6bc6d681
+lib/loaders/user_admin_privilege_list_loader.rb 314945a85d2c789060066f9629596f66915d892b

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'typhoeus'
+gem 'json'
+
+group :development, :test do
+  gem 'autotest'
+  gem 'rspec'
+  gem 'ruby-debug19'
+  gem 'factory_girl'
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.8.1)
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    archive-tar-minitar (0.5.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    columnize (0.3.6)
+    diff-lcs (1.1.3)
+    factory_girl (3.5.0)
+      activesupport (>= 3.0.0)
+    i18n (0.6.0)
+    json (1.7.3)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    mime-types (1.18)
+    multi_json (1.3.6)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    typhoeus (0.3.3)
+      mime-types
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  factory_girl
+  json
+  rspec
+  ruby-debug19
+  typhoeus

data/README

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

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rspec/core/rake_task'
+
+
+desc 'Default: run specs.'
+task :default => :spec
+task :test => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end
+
+
+
+namespace :docs do
+
+  desc 'Build the docs for The City Admin API.'
+  task :build do
+    system('rm -rf doc')
+    system('yardoc --no-private --protected lib/**/*.rb')
+  end
+
+end

data/index.rb

@@ -0,0 +1,123 @@
+# *******************************************
+# 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'
+
+# staging
+# key = 'bc6b57204b0ee4818bb4b3befd0f3292e93a2d0a'
+# token = '7cfed59b037125d3' 
+
+# Local
+key = '66c59e2ee24553e7237259e30b4c17365681b95c'
+token = 'a9ae4af3c3e80102'
+
+
+TheCity::AdminApi.connect(key, token)
+
+###### USERS / GROUPS #######
+
+puts "-----------------------------"
+
+user = TheCity::User.new
+user.title = 'Deacon'
+user.first = 'James'
+user.middle = 'Wesley'
+user.last = 'Hays'
+user.nickname = 'Wes'
+user.gender = TheCity::User::Gender[:male]
+user.email = 'wes+tc6@onthecity.org'
+user.staff = false
+user.member_since = Time.now.strftime("%Y-%m-%d")
+user.birthdate = '1980-09-27'
+user.primary_phone = '775-745-3013'
+user.primary_phone_type = TheCity::User::PhoneType[:mobile]
+user.secondary_phone = '775-677-7707'
+user.secondary_phone_type = TheCity::User::PhoneType[:home]
+#user.marital_status = TheCity::User::MaritalStatus[:married]
+#user.primary_campus_id
+#user.external_id_1
+#user.external_id_2
+#user.external_id_3
+unless user.save
+  user.error_messages.each { |em| puts em }
+end
+
+user.delete
+
+
+# puts "-----------------------------"
+
+
+# user = the_city.users[0]
+# puts user.full_name
+# user.first = 'Wes'
+# puts user.full_name
+# user.save
+# puts user.id
+# user2 = TheCity::User.load_user_by_id(user.id)
+# puts user2.full_name
+
+# group = the_city.groups[0]
+# puts group.name
+# group.name = 'Wes Group'
+# puts group.name
+# group.save
+# group2 = TheCity::Group.load_group_by_id(group.id)
+# puts group2.name
+
+
+
+
+###### USERS #######
+
+# user = the_city.users[0]
+# puts user.full_name
+
+
+# user2 = TheCity::User.load_user_by_id(1068169470) #(564114313)
+# puts user2.full_name
+
+# user = the_city.users[1]
+# puts user.full_name
+
+# This is currenly returning a 404 if no family members are found
+# puts user.family[0].name
+
+# puts user.addresses[0].location_type
+# puts user.notes[0].author
+# puts user.roles[0].group_name
+# puts user.skills[0].name
+# puts user.processes[0].name
+# puts user.invitations[0].source
+# puts user.admin_privileges[0].title
+
+
+###### GROUPS #######
+
+# group = the_city.groups[0]
+# puts group.name
+# puts group.id
+
+# Fails with 500 error
+# puts group.addresses[0].location_type
+
+# puts group.roles[0].user_name
+# puts group.tags[0].name
+
+# puts group.invitations[0].source
+
+# metric = the_city.metrics[0]
+
+# puts metric.name
+# metric.measurements.total_entries.times do |i|
+#   puts "#{metric.measurements[i].created_at}: #{metric.measurements[i].value}"
+# end
+# new_measurement = TheCity::MetricMeasurement.new(:id => metric.id, :value => 999)
+# new_measurement.save
+
+

data/lib/common.rb

@@ -1,31 +1,38 @@
 module TheCity
   require 'cgi'
 
-  def self.admin_request(method, path, params = {})    
-    # data_params = params.inject({}) {|h, (k,v)| h.update({k => v.nil? ? v : v.to_s})}
-    # flattened_params = self._flatten_params(data_params)
 
-    flattened_params = self._flatten_params(params)
-
-# puts "############################"
-# puts "flattened_params: #{flattened_params}"
-# puts "############################"
-
-    headers = self._build_admin_headers(method, path, flattened_params) 
+  def self.admin_request(method, path, params = {})
+    headers = self._build_admin_headers(method, path, params)
     url = THE_CITY_ADMIN_PATH+path
 
-    response = 
-    case method 
+    data_params = params.inject({}) {|h, (k,v)| h.update({k => v.nil? ? v : CGI.escape(v.to_s)})}
+
+    response =
+    case method
     when :post
-      Typhoeus::Request.post(url, {:headers => headers, :params => flattened_params})
-    when :get  
-      Typhoeus::Request.get(url, {:headers => headers, :params => flattened_params})
-    when :put  
-      Typhoeus::Request.put(url, {:headers => headers, :params => flattened_params})
-    when :delete      
-      Typhoeus::Request.delete(url, {:headers => headers, :params => flattened_params})
+      Typhoeus::Request.post(url, {:headers => headers, :params => self._flatten_params(data_params)})
+    when :get
+      Typhoeus::Request.get(url, {:headers => headers, :params => self._flatten_params(data_params)})
+    when :put
+      Typhoeus::Request.put(url, {:headers => headers, :params => self._flatten_params(data_params)})
+    when :delete
+      Typhoeus::Request.delete(url, {:headers => headers, :params => self._flatten_params(data_params)})
     end
 
+    # unless response.success?
+    #   if response.curl_error_message != 'No error'
+    #     raise TheCityExceptions::UnableToConnectToTheCity.new(response.curl_error_message)
+    #   else
+    #     begin
+    #       raise TheCityExceptions::TheCityResponseError.new( JSON.parse(response.body)['error_message'] )
+    #     rescue
+    #       raise TheCityExceptions::UnknownErrorConnectingToTheCity.new('Unknown error when connecting to The City')
+    #     end
+    #   end
+    # end
+
+
     unless response.success?
       if response.curl_error_message != 'No error'
         raise TheCityExceptions::UnableToConnectToTheCity.new(response.curl_error_message)
@@ -38,66 +45,28 @@ module TheCity
           raise TheCityExceptions::TheCityResponseError.new(error_messages)
         end
       end
-    end
-
+    end    
+    
     response
   end
 
 
-  def self._flatten_params(params, prefix='')
-    retval = []
-    if params.instance_of?(Array)
-      if params.empty?
-        retval << self._flatten_params('', "#{prefix.to_s}[0]")
-      else
-        params.each_with_index do |value, indx|
-          retval << self._flatten_params(value, "#{prefix.to_s}[#{indx}]")
-        end
-      end
-    elsif params.instance_of?(Hash)
-      params.each do |key, value|
-        retval << self._flatten_params(value, prefix.empty? ? key.to_s : "#{prefix}[#{key.to_s}]")
+  def self._flatten_params(params)
+    retval = {}
+    params.each do |key, value|
+      if value.instance_of?(Array)
+        value.each_with_index { |a_val, indx| retval["#{key}[#{indx}]"] = a_val }
+      else # assume string
+        retval[key] = value
       end
-    else # assume string
-      retval << "#{prefix}=#{params}"
     end
-
-    if prefix.empty?
-      hvals = {}
-      retval.flatten.sort.each { |v| hvals[v.split('=')[0]] = v.split('=')[1] }
-      hvals
-    else  
-      retval.flatten.sort
-    end
-    #retval.flatten.sort
+    retval
   end
 
 
-
-  def self._build_admin_headers(method, path, params) 
-    # get_vars = '?' + params.to_a.sort.collect { |kv_pair| "#{kv_pair[0]}=#{kv_pair[1]}" }.join('&')
-    # get_vars = '' if get_vars == '?'
-
-
-    get_vars = '?' + params.to_a.sort.collect { |kv_pair| 
-      if kv_pair[1].class == Array
-        puts "ARRAY"
-        kv_pair[1].each_with_index do |v, indx|
-          "#{kv_pair[0]}[#{indx}]=#{v}" 
-        end
-      else
-        "#{kv_pair[0]}=#{kv_pair[1]}" 
-      end
-    }.join('&')
+  def self._build_admin_headers(method, path, params)
+    get_vars = '?' + params.to_a.sort.collect { |kv_pair| "#{kv_pair[0]}=#{kv_pair[1]}" }.join('&')
     get_vars = '' if get_vars == '?'
-
-
-# puts "############################"
-# puts "params: #{params}"
-# puts '------------'
-# puts "get_vars: #{get_vars}"
-# puts "############################"
-
     method_request = method.to_s.upcase
     url = THE_CITY_ADMIN_PATH + path + get_vars
     current_time = Time.now.to_i.to_s
@@ -114,11 +83,133 @@ module TheCity
 
     # This is causing issues.... not sure if it is needed (docs might be lieing)
     # if [:post, :put].include?(method)
-    #   headers['Content-Type'] = 'application/json'
-    #   headers['Content-Length'] = params.to_json.length
+    # headers['Content-Type'] = 'application/json'
+    # headers['Content-Length'] = params.to_json.length
     # end
 
     headers
-  end  
+  end 
+
+
+
+#   def self.admin_request(method, path, params = {})    
+#     # data_params = params.inject({}) {|h, (k,v)| h.update({k => v.nil? ? v : v.to_s})}
+#     # flattened_params = self._flatten_params(data_params)
+
+#     flattened_params = self._flatten_params(params)
+
+# # puts "############################"
+# # puts "flattened_params: #{flattened_params}"
+# # puts "############################"
+
+#     headers = self._build_admin_headers(method, path, flattened_params) 
+#     url = THE_CITY_ADMIN_PATH+path
+
+#     response = 
+#     case method 
+#     when :post
+#       Typhoeus::Request.post(url, {:headers => headers, :params => flattened_params})
+#     when :get  
+#       Typhoeus::Request.get(url, {:headers => headers, :params => flattened_params})
+#     when :put  
+#       Typhoeus::Request.put(url, {:headers => headers, :params => flattened_params})
+#     when :delete      
+#       Typhoeus::Request.delete(url, {:headers => headers, :params => flattened_params})
+#     end
+
+#     unless response.success?
+#       if response.curl_error_message != 'No error'
+#         raise TheCityExceptions::UnableToConnectToTheCity.new(response.curl_error_message)
+#       else
+#         begin
+#           error_messages = JSON.parse(response.body)['error_message']
+#         rescue
+#           raise TheCityExceptions::UnknownErrorConnectingToTheCity.new('Unknown error when connecting to The City')
+#         else
+#           raise TheCityExceptions::TheCityResponseError.new(error_messages)
+#         end
+#       end
+#     end
+
+#     response
+#   end
+
+
+#   def self._flatten_params(params, prefix='')
+#     retval = []
+#     if params.instance_of?(Array)
+#       if params.empty?
+#         retval << self._flatten_params('', "#{prefix.to_s}[0]")
+#       else
+#         params.each_with_index do |value, indx|
+#           retval << self._flatten_params(value, "#{prefix.to_s}[#{indx}]")
+#         end
+#       end
+#     elsif params.instance_of?(Hash)
+#       params.each do |key, value|
+#         retval << self._flatten_params(value, prefix.empty? ? key.to_s : "#{prefix}[#{key.to_s}]")
+#       end
+#     else # assume string
+#       retval << "#{prefix}=#{params}"
+#     end
+
+#     if prefix.empty?
+#       hvals = {}
+#       retval.flatten.sort.each { |v| hvals[v.split('=')[0]] = v.split('=')[1] }
+#       hvals
+#     else  
+#       retval.flatten.sort
+#     end
+#     #retval.flatten.sort
+#   end
+
+
+
+#   def self._build_admin_headers(method, path, params) 
+#     # get_vars = '?' + params.to_a.sort.collect { |kv_pair| "#{kv_pair[0]}=#{kv_pair[1]}" }.join('&')
+#     # get_vars = '' if get_vars == '?'
+
+
+#     get_vars = '?' + params.to_a.sort.collect { |kv_pair| 
+#       if kv_pair[1].class == Array
+#         puts "ARRAY"
+#         kv_pair[1].each_with_index do |v, indx|
+#           "#{kv_pair[0]}[#{indx}]=#{v}" 
+#         end
+#       else
+#         "#{kv_pair[0]}=#{kv_pair[1]}" 
+#       end
+#     }.join('&')
+#     get_vars = '' if get_vars == '?'
+
+
+# # puts "############################"
+# # puts "params: #{params}"
+# # puts '------------'
+# # puts "get_vars: #{get_vars}"
+# # puts "############################"
+
+#     method_request = method.to_s.upcase
+#     url = THE_CITY_ADMIN_PATH + path + get_vars
+#     current_time = Time.now.to_i.to_s
+#     string_to_sign = current_time.to_s + method_request + url
+#     unencoded_hmac = OpenSSL::HMAC.digest('sha256', TheCity::AdminApi::API_KEY, string_to_sign)
+#     unescaped_hmac = Base64.encode64(unencoded_hmac).chomp
+#     hmac_signature = CGI.escape(unescaped_hmac)
+
+#     headers = {'X-City-Sig' => hmac_signature,
+#                'X-City-User-Token' => TheCity::AdminApi::API_TOKEN,
+#                'X-City-Time' => current_time,
+#                'Accept' => 'application/vnd.thecity.admin.v1+json'}
+
+
+#     # This is causing issues.... not sure if it is needed (docs might be lieing)
+#     # if [:post, :put].include?(method)
+#     #   headers['Content-Type'] = 'application/json'
+#     #   headers['Content-Length'] = params.to_json.length
+#     # end
+
+#     headers
+#   end  
 
 end