the-city-admin 0.3.1 → 0.4.0

data/.gitignore

@@ -4,4 +4,5 @@ doc/*
 the-city-admin-*.gem
 bin/
 .bundle/
-.rbenv-version
+.rbenv-version
+index.rb

data/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'typhoeus', '0.4.2'
+gem 'typhoeus', '0.5.1'
 gem 'json'
 
 group :development, :test do

data/Gemfile.lock

@@ -16,9 +16,12 @@ GEM
       debugger-ruby_core_source (>= 1.1.1)
     debugger-ruby_core_source (1.1.3)
     diff-lcs (1.1.3)
+    ethon (0.5.3)
+      ffi (~> 1.0.11)
+      mime-types (~> 1.18)
     factory_girl (4.0.0)
       activesupport (>= 3.0.0)
-    ffi (1.1.5)
+    ffi (1.0.11)
     i18n (0.6.1)
     json (1.7.5)
     mime-types (1.19)
@@ -31,9 +34,8 @@ GEM
     rspec-expectations (2.11.2)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.2)
-    typhoeus (0.4.2)
-      ffi (~> 1.0)
-      mime-types (~> 1.18)
+    typhoeus (0.5.1)
+      ethon (= 0.5.3)
 
 PLATFORMS
   ruby
@@ -44,4 +46,4 @@ DEPENDENCIES
   factory_girl
   json
   rspec
-  typhoeus (= 0.4.2)
+  typhoeus (= 0.5.1)

data/examples/tags.rb

@@ -17,55 +17,45 @@ TheCity::AdminApi.connect(KEY, TOKEN)
 puts "------------------------------------"
 
 tag_list = TheCity::TagList.new
-if tag_list.empty?
-  puts "No tags in list"
-else
-  puts "Tags: #{tag_list.count}"
-end
+puts "Tags: #{tag_list.total_entries}"
 
+
+puts "*******************"
 tag = TheCity::Tag.new
-tag.name = 'Z Cool Guy'
+tag.name = 'zProgrammer'
+
 if tag.save
-  puts "Tag created (#{tag.id})"
+  puts "Tag SAVED"
 else
-  puts "Failed to create tag: #{tag.error_messages.join(', ')}"
+  puts "FAILED TO SAVE TAG: #{tag.error_messages}"
 end
+puts "*******************"
 
+tag_list = TheCity::TagList.new
+puts "Tags: #{tag_list.total_entries}"
 
-tag_list2 = TheCity::TagList.new
-if tag_list2.empty?
-  puts "No tags in list"
-else
-  puts "Tags: #{tag_list2.count}"
-end
+puts "*******************"
+tag.name = 'zProgrammer 2'
 
-tag2 = TheCity::Tag.load_by_id(tag.id)
-if tag2.nil?
-  puts "Tag not found"
+if tag.save
+  puts "Tag Updated"
 else
-  puts "Tag found by ID #{tag.id}"
+  puts "FAILED TO SAVE TAG: #{tag.error_messages}"
 end
+puts "*******************"
 
 
-tag.name = 'Z Some Guy'
-if tag.save
-  puts "Tag updated (#{tag.id})"
+puts "*******************"
+if tag.delete
+  puts "Tag Deleted"
 else
-  puts "Failed to update tag: #{tag.error_messages.join(', ')}"
+  puts "FAILED TO DELETE TAG: #{tag.error_messages}"
 end
+puts "*******************"
 
 
-if tag.delete 
-  puts "Tag #{tag.id} deleted"
-else
-  puts "Unable to delete tag #{tag.id}: #{tag.error_messages.join(', ')}"
-end
+tag_list = TheCity::TagList.new
+puts "Tags: #{tag_list.total_entries}"
 
-tag_list3 = TheCity::TagList.new
-if tag_list3.empty?
-  puts "No tags in list"
-else
-  puts "Tags: #{tag_list3.count}"
-end
 
 puts "####################################"

data/lib/api/group.rb

@@ -55,6 +55,7 @@ module TheCity
       elsif reader.is_a?(Hash)
         initialize_from_json_object(reader)
       end
+      @writer_object = GroupWriter
 
       @address_list = nil
       @checkin_list = nil
@@ -163,16 +164,6 @@ module TheCity
       return @tag_list
     end     
 
-
-
-    # Save this object.
-    #
-    # @return True on success, otherwise false.
-    def save
-      writer = GroupWriter.new(self.to_attributes) 
-      writer.save_feed
-    end
-
   end
 
 end

data/lib/api/skill.rb

@@ -6,12 +6,27 @@ module TheCity
                      :name,
                      :created_at
 
+
+    # Loads the skill by the specified ID.
+    #
+    # @param skill_id The ID of the skill to load.
+    #
+    # Returns a new {Skill} object.
+    def self.load_by_id(fund_id)
+      skill_reader = SkillReader.new(fund_id)
+      self.new(skill_reader)
+    end       
+
     # Constructor.
     #
-    # @param json_data (optional) JSON data of the Skill.
-    def initialize(json_data = nil)
+    # @param reader (optional) The object that has the data.  This can be a {SkillReader} or Hash object.
+    def initialize(reader = nil)
       @writer_object = SkillWriter
-      initialize_from_json_object(json_data) unless json_data.nil?
+      if reader.is_a?(SkillReader)
+        initialize_from_json_object(reader.load_feed) 
+      elsif reader.is_a?(Hash)
+        initialize_from_json_object(reader)
+      end
     end
     
   end

data/lib/common.rb

@@ -3,25 +3,26 @@ module TheCity
   require 'json'
 
 
-  def self.admin_request(method, path, params = {})
-    headers = self._build_admin_headers(method, path, params)
+  def self.admin_request(method, path, params = {}, body = '')
+    headers = self._build_admin_headers(method, path, params, body)
     url = THE_CITY_ADMIN_PATH+path
 
     response =
     case method
     when :post
-      Typhoeus::Request.post(url, {:headers => headers, :params => params})
+      Typhoeus::Request.post(url, {:headers => headers, :body => body})
     when :get
       Typhoeus::Request.get(url, {:headers => headers, :params => params})
     when :put
-      Typhoeus::Request.put(url, {:headers => headers, :params => params})
+      Typhoeus::Request.put(url, {:headers => headers, :body => body})
     when :delete
       Typhoeus::Request.delete(url, {:headers => headers, :params => params})
     end    
 
+
     unless response.success?
-      if response.curl_error_message != 'No error'
-        raise TheCityExceptions::UnableToConnectToTheCity.new(response.curl_error_message)
+      if response.code > 0
+        raise TheCityExceptions::UnableToConnectToTheCity.new(response.body)
       else
         begin
           error_messages = JSON.parse(response.body)['error_message']
@@ -38,14 +39,17 @@ module TheCity
   end
 
 
-  def self._build_admin_headers(method, path, params)
+  def self._build_admin_headers(method, path, params, body)
     get_vars = method == :post ? '' : '?'
-    get_vars += params.to_a.sort.collect { |kv_pair| "#{kv_pair[0]}=#{kv_pair[1].to_s}" }.join('&')
+    if params
+      get_vars += params.to_a.sort.collect { |kv_pair| "#{kv_pair[0]}=#{kv_pair[1].to_s}" }.join('&')
+    end
     get_vars = '' if get_vars == '?'
     method_request = method.to_s.upcase
-    url = THE_CITY_ADMIN_PATH + path + get_vars
+    url = THE_CITY_ADMIN_PATH + path + get_vars + body
     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)
@@ -54,7 +58,8 @@ module TheCity
      'X-City-User-Token' => TheCity::AdminApi::API_TOKEN,
      'X-City-Time' => current_time,
      'Accept' => 'application/vnd.thecity.admin.v1+json',
-     'Content-Type' => 'application/json'}
+     'Content-Type' => 'application/json',
+     'Content-Length' => body.length}
   end 
 
 end

data/lib/readers/api_reader.rb

@@ -18,30 +18,26 @@ module TheCity
         @url_data_params ||= {}
         response = TheCity::admin_request(:get, @url_data_path, @url_data_params)
         data = JSON.parse(response.body)
-        @headers = parse_headers(response.headers) if response.headers
+        @headers = response.headers
         @cacher.save_data(@class_key, data) unless @cacher.nil?
       #end   
 
       return data
     end
 
-    def parse_headers(headers)
-      Hash[headers.split("\r\n").collect { |pair| pair.split(': ') }]
-    end
-
-    # Returns either the value of the X-City-RateLimit-Limit-By-Ip header or
-    # X-City-RateLimit-Limit-By-Account header, whichever is lower.
+    # Returns either the value of the x-city-ratelimit-limit-by-ip header or
+    # x-city-ratelimit-limit-by-account header, whichever is lower.
     def rate_limit
       if @headers
-        [@headers['X-City-RateLimit-Limit-By-Ip'].to_i, @headers['X-City-RateLimit-Limit-By-Account'].to_i].min
+        [@headers['x-city-ratelimit-limit-by-ip'].to_i, @headers['x-city-ratelimit-limit-by-account'].to_i].min
       end
     end
 
-    # Returns either the value of the X-City-RateLimit-Remaining-By-Ip header or
-    # X-City-RateLimit-Remaining-By-Account header, whichever is lower.
+    # Returns either the value of the x-city-ratelimit-remaining-by-ip header or
+    # x-city-ratelimit-remaining-by-account header, whichever is lower.
     def rate_limit_remaining
       if @headers
-        [@headers['X-City-RateLimit-Remaining-By-Ip'].to_i, @headers['X-City-RateLimit-Remaining-By-Account'].to_i].min
+        [@headers['x-city-ratelimit-remaining-by-ip'].to_i, @headers['x-city-ratelimit-remaining-by-account'].to_i].min
       end
     end
 

data/lib/readers/skill_reader.rb

@@ -0,0 +1,21 @@
+module TheCity
+
+  class SkillReader < ApiReader
+
+    # Constructor.
+    #
+    # <b>skill_id</b> The ID of the skill to load.
+    # <b>CacheAdapter cacher</b> (optional) The cacher to be used to cache data.
+    def initialize(skill_id, cacher = nil)
+      #@class_key = "funds_#{fund_id}"   
+      @url_data_path = "/skills/#{skill_id}"
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+    
+  end
+
+end
+
+

data/lib/writers/api_writer.rb

@@ -22,7 +22,7 @@ module TheCity
       end
 
       begin
-        response = TheCity::admin_request(@url_action, @url_data_path, @url_data_params)   
+        response = TheCity::admin_request(@url_action, @url_data_path, nil, @url_data_params.to_json)   
         @response_code = response.code
         # No content but is a success
         success = response.code == 204 ? {'success' => true} : JSON.parse(response.body)  

data/thecity_admin_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   PROJECT_GEM = 'the-city-admin'
-  PROJECT_GEM_VERSION = '0.3.1'
+  PROJECT_GEM_VERSION = '0.4.0'
   
   s.name = PROJECT_GEM
   s.version = PROJECT_GEM_VERSION
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   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', '0.4.2')
+  s.add_dependency('typhoeus', '0.5.1')
 
 
   s.files         = `git ls-files`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the-city-admin
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.1
 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
@@ -59,7 +59,6 @@ files:
 - examples/thecity_headers.rb
 - examples/users.rb
 - examples/webhooks.rb
-- index.rb
 - lib/api/address.rb
 - lib/api/address_list.rb
 - lib/api/api_object.rb
@@ -165,6 +164,7 @@ files:
 - lib/readers/pledge_reader.rb
 - lib/readers/role_list_reader.rb
 - lib/readers/skill_list_reader.rb
+- lib/readers/skill_reader.rb
 - lib/readers/skilled_user_id_list_reader.rb
 - lib/readers/skilled_user_list_reader.rb
 - lib/readers/tag_group_list_reader.rb

data/index.rb

@@ -1,356 +0,0 @@
-# *******************************************
-# This is a demo file to show usage.
-#
-# @package TheCity::Admin
-# @authors Robbie Lieb <robbie@onthecity.org>, Wes Hays <wes@onthecity.org>
-# ******************************************* 
-
-# TCA_ENV = 'development' 
-# THE_CITY_ADMIN_PATH = 'http://api.devthecity.org:9292' 
-# key = 'Dev Key'
-# token = 'dev token'
-
-key = 'YOUR KEY'
-token = 'YOUR TOKEN'
-
-require 'open-uri'
-require 'csv'
-require 'ruby-debug'
-require File.dirname(__FILE__) + '/lib/the_city_admin.rb'
-
-TheCity::AdminApi.connect(key, token)
-
-# group_export = TheCity::GroupExport.new
-# group_export.group_id = 73608
-# if group_export.save
-#   puts "Export created"
-# else
-#   puts "Export failed: #{group_export.error_messages.join(', ')}"
-# end
-
-
-# done = false
-# page = 1
-# count = 0
-
-# while !done
-#   export_list = TheCity::GroupExportList.new({:page => page, :group_id => 73608})
-  
-#   export_list.each do |export|
-#     count += 1
-#     puts "#{count}) #{export.id} :: #{export.state}"
-#   end
-
-#   if export_list.total_pages <= page
-#     done = true
-#   else
-#     page += 1
-#   end
-# end
-
-# export_list = TheCity::GroupExportList.new({:page => page, :group_id => 73608})
-# group_export = export_list[0]
-# puts group_export.inspect
-
-
-
-group_export = TheCity::GroupExport.load_by_id(100996, {:group_id => 73608})
-path = group_export.authenticated_s3_url
-
-data = open(path).read()
-
-CSV.parse(data, {:headers => true}).each do |row| 
-  puts [row[2], row[4]].join(' ')
-end
-
-
-# puts "-----------------------------"
-# puts "##### Web Hooks #######"
-# puts "-----------------------------"
-
-# web_hooks = TheCity::WebHookList.new({:page => 1})
-# web_hooks.each do |hook|
-#   puts hook.inspect
-# end
-
-# web_hook1 = TheCity::WebHook.new({:callback_uri => 'https://www.somedomain.com/city/callbacks/fund/create', 
-#                                   :object => TheCity::WebHook::Objects[:fund],
-#                                   :event => TheCity::WebHook::Events[:create]})
-
-# web_hook2 = TheCity::WebHook.new({:callback_uri => 'https://www.somedomain.com/city/callbacks/pledge/create', 
-#                                   :object => TheCity::WebHook::Objects[:pledge],
-#                                   :event => TheCity::WebHook::Events[:create]})
-
-# web_hook3 = TheCity::WebHook.new({:callback_uri => 'https://www.somedomain.com/city/callbacks/donation/create', 
-#                                   :object => TheCity::WebHook::Objects[:donation],
-#                                   :event => TheCity::WebHook::Events[:create]})
-
-# puts web_hook1.save ? 'Web Hook saved' : 'Web Hook failed'
-# puts web_hook2.save ? 'Web Hook saved' : 'Web Hook failed'
-# puts web_hook3.save ? 'Web Hook saved' : 'Web Hook failed'
-
-# web_hooks = TheCity::WebHookList.new({:page => 1})
-# web_hooks.each do |hook|
-#   puts hook.inspect
-#   puts hook.delete
-# end
-
-
-# puts "-----------------------------"
-# puts "##### Invitations #######"
-# puts "-----------------------------"
-
-# invitation_list = TheCity::InvitationList.new({:page => 1})
-
-# invitation_list.each do |invitation|
-#   puts invitation.inspect
-# end
-
-# puts "-----------------------------"
-# puts "##### FUNDS / DONATIONS / PLEDGES #######"
-# puts "-----------------------------"
-
-
-# donation_list = TheCity::DonationList.new({:page => 1, :include_details => 1, :start_date => '2012-09-01', :end_date => '2012-09-30'})
-
-# donation_list.each do |donation|
-#   puts [donation.user_name, donation.amount].join(' :: ')
-# end
-
-
-# fund_list = TheCity::FundList.new({:page => 1})
-
-# fund_list.each do |fund|
-#   puts [fund.id, fund.name].join(' :: ')
-# end
-
-# sfund = TheCity::Fund.load_fund_by_id(fund_list.first.id)
-
-# puts [sfund.id, sfund.name].join(' :-: ')
-
-# done = false
-# page = 1
-# count = 0
-
-# while !done
-#   group_list = TheCity::GroupList.new({:page => page, :group_types => 'CG', :include_inactive => true})
-
-#   group_list.each do |group|
-#     count += 1
-#     puts "#{count}) #{group.name} [#{group.group_type}]"
-#   end
-
-#   if group_list.total_pages <= page
-#     done = true
-#   else
-#     page += 1
-#   end
-# end
-
-
-# done = false
-# page = 1
-# count = 0
-
-# while !done
-#   tag_list = TheCity::TagList.new({:page => page})
-  
-#   tag_list.each do |tag|
-#     count += 1
-#     puts "#{count}) #{tag.name} :: #{tag.id}"
-#   end
-
-#   if tag_list.total_pages <= page
-#     done = true
-#   else
-#     page += 1
-#   end
-# end
-
-# tag_list = TheCity::TagList.new({:page => page})
-# tag = tag_list[0]
-
-# puts tag.name
-# tag.name = "Wes Hays #{Random.rand(99999)}"
-# if tag.save
-#   puts "TAG SAVED"
-# else
-#   puts "TAG FAILED TO SAVE: #{tag.error_messages}"
-# end
-
-
-
-
-
-# puts "-----------------------------"
-# puts "##### USERS #######"
-# puts "-----------------------------"
-
-
-# wes = TheCity::User.load_by_id(746076)
-
-# wes.first = "Jim"
-# if wes.save
-#   puts "Wes Saved"
-# else
-#   puts "WES FAILED TO SAVE: #{wes.error_messages}"
-# end
-
-
-# user_list = TheCity::UserList.new
-
-# user_list.each do |u|
-#   puts u.full_name
-# end
-
-# 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 = 'someguy@somewhere.org'
-# user.staff = false
-# user.member_since = Time.now.strftime("%Y-%m-%d")
-# user.birthdate = '1980-09-27'
-# user.primary_phone = '775-111-2222'
-# user.primary_phone_type = TheCity::User::PhoneType[:mobile]
-# user.secondary_phone = '775-333-4444'
-# 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
-
-# if user.save
-#   puts "User #{user.full_name} saved (#{user.id})"
-# else
-#   user.error_messages.each { |em| puts em }
-# end
-
-# user2 = TheCity::User.load_by_id(user.id)
-# user2.email = 'somegirl@somewhere.org'
-# user2.nickname = 'dog'
-
-# if user2.save
-#   puts "User #{user2.full_name} updated (#{user2.id})"
-# else
-#   user2.error_messages.each { |em| puts em }
-# end
-
-# if user.delete
-#   puts "User #{user.full_name} deleted (#{user.id})"
-# else
-#   puts "Something bad happened"
-#   #user.error_messages.each { |em| puts em }
-# end
-
-
-# puts "-----------------------------"
-
-# user_list = TheCity::UserList.new
-
-# user = user_list[0]
-# puts user.full_name
-# user.first = 'Wes'
-# puts user.full_name
-# user.save
-# puts user.id
-
-# user2 = TheCity::User.load_by_id(user.id)
-# puts user2.full_name
-
-# puts "User has #{user.addresses.size} addresses"
-# puts "User has #{user.family.size} family members"
-# puts "User has #{user.notes.size} notes"
-# puts "User has #{user.roles.size} roles"
-# puts "User has #{user.skills.size} skills"
-# #puts "User has #{user.processes.size} processes"
-# puts "User has #{user.invitations.size} invitations"
-# #puts "User has #{user.admin_privileges.size} admin_privileges"
-
-
-# This is currenly returning a 404 if no family members are found
-# puts user.family[0].name
-
-
-
-# puts "-----------------------------"
-
-
-# group_list = TheCity::GroupList.new(:)
-# puts group.name
-# group.name = 'Wes Group'
-# puts group.name
-# group.save
-# group2 = TheCity::Group.load_by_id(group.id)
-# puts group2.name
-
-
-# puts "-----------------------------"
-# puts "##### GROUPS #######"
-# puts "-----------------------------"
-
-# group_list = TheCity::GroupList.new
-
-# group = group_list[13]
-# puts "Group Name: #{group.name} (#{group.id})"
-
-# if group.roles.size == 0
-#   puts "No group roles found"
-# else
-#   puts group.roles[0].title
-# end
-
-# if group.tags.size == 0
-#   puts "No group tags found"
-# else
-#   puts group.tags[0].name
-# end
-
-# if group.invitations.size == 0
-#   puts "No group invitations found"
-# else
-#   puts group.invitations[0].id
-# end
-
-
-# puts "-----------------------------"
-# puts "##### SKILLS #######"
-# puts "-----------------------------"
-
-# skill_list = TheCity::SkillList.new
-
-# puts skill_list.inspect
-
-# # skill_list.each do |skill|
-# #   puts skill.name
-# # end
-
-
-# puts "-----------------------------"
-# puts "##### USERS #######"
-# puts "-----------------------------"
-
-# done = false
-# page = 1
-
-
-# while !done
-#   user_list = TheCity::UserList.new({:page => page})
-
-#   user_list.each do |user|
-#     puts user.full_name
-#   end
-
-#   if user_list.total_pages <= page
-#     done = true
-#   else
-#     page += 1
-#   end
-# end
-