the-city-admin 0.2.0 → 0.2.1

data/index.rb

@@ -5,8 +5,8 @@
 # @authors Robbie Lieb <robbie@onthecity.org>, Wes Hays <wes@onthecity.org>
 # ******************************************* 
 
-# TCA_ENV = 'development' 
-# THE_CITY_ADMIN_PATH = 'http://api.devthecity.org:9292' 
+TCA_ENV = 'development' 
+THE_CITY_ADMIN_PATH = 'http://api.devthecity.org:9292' 
 
 require 'ruby-debug'
 require File.dirname(__FILE__) + '/lib/the_city_admin.rb'
@@ -14,16 +14,58 @@ require File.dirname(__FILE__) + '/lib/the_city_admin.rb'
 # key = '66c59e2ee24553e7237259e30b4c17365681b95c'
 # token = 'a9ae4af3c3e80102'
 
-key = '2bcee1fdccd31f1ef35a7c6708daf5a446a61ee2'
-token = 'e37ae7fb2042a17a'
+key = 'cf2903151e3213e66fd8080c7d8b65b1d6ccdd31'
+token = '5c88b32edda7653c'
 
 TheCity::AdminApi.connect(key, token)
 
 
 puts "-----------------------------"
-puts "##### FUNDS / DONATIONS / PLEDGES #######"
+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'})
 
@@ -32,15 +74,15 @@ puts "-----------------------------"
 # end
 
 
-fund_list = TheCity::FundList.new({:page => 1})
+# fund_list = TheCity::FundList.new({:page => 1})
 
-fund_list.each do |fund|
-  puts [fund.id, fund.name].join(' :: ')
-end
+# fund_list.each do |fund|
+#   puts [fund.id, fund.name].join(' :: ')
+# end
 
-sfund = TheCity::Fund.load_fund_by_id(fund_list.first.id)
+# sfund = TheCity::Fund.load_fund_by_id(fund_list.first.id)
 
-puts [sfund.id, sfund.name].join(' :-: ')
+# puts [sfund.id, sfund.name].join(' :-: ')
 
 # done = false
 # page = 1

data/lib/api/group.rb

@@ -13,16 +13,18 @@ module TheCity
                      :parent_id, 
                      :plaza_url, 
                      :smart_large_profile_pic, 
-                     :started_as_seed
+                     :started_as_seed,
+                     :user_ids
 
 
     # Loads the group by the specified ID.
     #
     # @param group_id The ID of the group to load.
+    # @param options A hash of options for requesting data from the server.
     #
     # Returns a new {Group} object.
-    def self.load_group_by_id(group_id)
-      group_reader = GroupReader.new(group_id)
+    def self.load_group_by_id(group_id, options = {})
+      group_reader = GroupReader.new(group_id, options)
       self.new(group_reader)
     end       
 

data/lib/api/invitation.rb

@@ -0,0 +1,31 @@
+module TheCity
+
+  class Invitation < ApiObject
+
+    tc_attr_accessor :created_at, 
+                     :pending_approval,
+                     :id,
+                     :group_id,
+                     :user_id,
+                     :custom_message,
+                     :source,
+                     :email,
+                     :title,
+                     :name,
+                     :external_id_1,
+                     :external_id_2,
+                     :external_id_3,
+                     :member_since
+
+
+    # Constructor.
+    #
+    # @param json_data JSON data of the invitation.
+    def initialize(json_data)
+      initialize_from_json_object(json_data)
+    end
+    
+  end
+
+end
+

data/lib/api/invitation_list.rb

@@ -0,0 +1,62 @@
+module TheCity
+
+  class InvitationList 
+
+    include Enumerable
+
+    attr_reader :total_entries, :total_pages, :per_page, :current_page
+
+    # Constructor.
+    #
+    # @param options A hash of options for loading the list.
+    # 
+    # Options:
+    #   :group_id - The ID of the group to load the roles for. (required)
+    #   :page - The page number to get.
+    #   :reader - The Reader to use to load the data.
+    #
+    #
+    # Examples:
+    #   InvitationList.new({:group_id => 12345})
+    #
+    #   InvitationList.new({:group_id => 12345, :page => 2})
+    #    
+    def initialize(options = {}) 
+      reader = options[:reader] || TheCity::InvitationListReader.new(options)  
+      @json_data = reader.load_feed
+
+      @total_entries = @json_data['total_entries']
+      @total_pages = @json_data['total_pages']
+      @per_page = @json_data['per_page']
+      @current_page = @json_data['current_page']      
+    end
+    
+    
+    # Get the specified group invitation.
+    #
+    # @param index The index of the group invitation to get.
+    #
+    # @return [Invitation]
+    def [](index)
+      Invitation.new( @json_data['invitations'][index] ) if @json_data['invitations'][index]
+    end
+
+
+    # This method is needed for Enumerable.
+    def each &block
+      @json_data['invitations'].each{ |invitation| yield( Invitation.new(invitation) )}
+    end    
+  
+    # Alias the count method
+    alias :size :count
+
+    # Checks if the list is empty.
+    #
+    # @return True on empty, false otherwise.
+    def empty?
+      @json_data['invitations'].empty?
+    end
+
+  end
+  
+end

data/lib/api/web_hook.rb

@@ -2,17 +2,17 @@ module TheCity
 
   class WebHook < ApiObject
 
-    Objects = {:user => 'User', :group => 'Group', :invitation => 'Invitation',
-               :privilege => 'Privilege', :checkin => 'Checkin', :address => 'Address'}
-
-    Events = {:create => 'create', :update => 'update', :destroy => 'destroy', :expire => 'expire'}              
-
-
     tc_attr_accessor :id,
                      :callback_uri, 
                      :event,
                      :object
 
+    Objects = {:user => 'user', :group => 'group', :invitation => 'invitation',
+               :privilege => 'privilege', :checkin => 'checkin', :address => 'address',
+               :group_tag => 'group_tag', :fund => 'fund', :pledge => 'pledge', :donation => 'donation'}
+
+    Events = {:create => 'create', :update => 'update', :destroy => 'destroy', :expire => 'expire'}              
+
     # Constructor.
     #
     # @param json_data (optional) JSON data of the web hook.

data/lib/readers/api_reader.rb

@@ -16,7 +16,7 @@ module TheCity
       # else
         @url_data_params ||= {}
         response = TheCity::admin_request(:get, @url_data_path, @url_data_params) 
-        data = JSON.parse(response.body)    
+        data = JSON.parse(response.body)     
         @cacher.save_data(@class_key, data) unless @cacher.nil?  
       #end   
 

data/lib/readers/group_list_reader.rb

@@ -4,8 +4,7 @@ module TheCity
 
     # Constructor.
     #
-    # @param page The page number to get.  Default is 1.
-    # @param options A hash of options for requesting data from the server.
+    # @param options A hash of options for requesting data from the server. Adds default of page 1 if page not set.
     # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
     def initialize(options = {}, cacher = nil) 
       options[:page] ||= 1

data/lib/readers/group_reader.rb

@@ -4,11 +4,13 @@ module TheCity
 
     # Constructor.
     #
-    # <b>group_id</b> The ID of the group to load.
-    # <b>CacheAdapter cacher</b> (optional) The cacher to be used to cache data.
-    def initialize(group_id, cacher = nil)
+    # @param group_id The ID of the group to load.
+    # @param options A hash of options for requesting data from the server.
+    # @param cacher (optional) The CacheAdapter cacher to be used to cache data.
+    def initialize(group_id, options = {}, cacher = nil)
       #@class_key = "groups_#{group_id}"   
       @url_data_path = "/groups/#{group_id}"
+      @url_data_params = options
       
       # The object to store and load the cache.
       @cacher = cacher unless cacher.nil?    

data/lib/readers/invitation_list_reader.rb

@@ -0,0 +1,22 @@
+module TheCity
+
+  class InvitationListReader < ApiReader
+
+    # Constructor.
+    #
+    # @param options A hash of options for requesting data from the server.
+    #                :: group_id is required
+    # @param [CacheAdapter] cacher (optional) The cacher to be used to cache data.
+    def initialize(options = {}, cacher = nil) 
+      page = options[:page] || 1
+      #@class_key = "invitations_#{page}"   
+      @url_data_path = "/invitations"
+      @url_data_params = {:page => page}
+      
+      # The object to store and load the cache.
+      @cacher = cacher unless cacher.nil?    
+    end
+
+  end
+
+end

data/thecity_admin_api.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   PROJECT_GEM = 'the-city-admin'
-  PROJECT_GEM_VERSION = '0.2.0'
+  PROJECT_GEM_VERSION = '0.2.1'
   
   s.name = PROJECT_GEM
   s.version = PROJECT_GEM_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the-city-admin
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-12 00:00:00.000000000 Z
+date: 2012-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -88,6 +88,8 @@ files:
 - lib/api/group_role_list.rb
 - lib/api/group_tag.rb
 - lib/api/group_tag_list.rb
+- lib/api/invitation.rb
+- lib/api/invitation_list.rb
 - lib/api/metric.rb
 - lib/api/metric_list.rb
 - lib/api/metric_measurement.rb
@@ -153,6 +155,7 @@ files:
 - lib/readers/group_reader.rb
 - lib/readers/group_role_list_reader.rb
 - lib/readers/group_tag_list_reader.rb
+- lib/readers/invitation_list_reader.rb
 - lib/readers/metric_list_reader.rb
 - lib/readers/metric_measurement_list_reader.rb
 - lib/readers/metric_measurement_reader.rb