mage-hand 0.3.2 → 0.4.0

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/lib/ob_port/base.rb

@@ -1,8 +1,19 @@
 module MageHand
   class Base
-    attr_accessor :id
+    @@simple_attributes = {}
+    @@instance_attributes = {}
     
-    def initialize(attributes)
+    def self.attr_simple(*method_names)
+      @@simple_attributes[self.name] = [] unless @@simple_attributes[self.name]
+      method_names.each do |method_name|
+        attr_accessor method_name
+        @@simple_attributes[self.name] << method_name
+      end
+    end
+    
+    attr_simple :id
+    
+    def initialize(attributes=nil)
       update_attributes!(attributes)
     end
      
@@ -15,6 +26,9 @@ module MageHand
     end
     
     def inflate
+      #if we don't have an id, the opject has not been created on the server yet
+      return unless self.id
+      
       hash = JSON.parse( MageHand::get_client.access_token.get(individual_url).body)
       update_attributes!(hash)
     end
@@ -22,7 +36,42 @@ module MageHand
     def self.model_name
       @_model_name ||= ActiveModel::Name.new(self)
     end
+    
+    def self.simple_attributes
+      @@simple_attributes[self.name] || []
+    end
+    
+    def simple_attributes
+      self.class.simple_attributes
+    end
+
+    def self.instance_attributes
+      @@instance_attributes[self.name] || []
+    end
+    
+    def instance_attributes
+      self.class.instance_attributes
+    end
+    
+    def self.attributes
+      simple_attributes + instance_attributes
+    end
+      
+    def attributes
+      self.class.attributes
+    end
 
+    def to_json(*a)
+      json_hash = {}
+      self.simple_attributes.each do |attribute|
+        json_hash[attribute.to_s] = self.send(attribute) if self.send(attribute)
+      end
+      self.instance_attributes.each do |attribute|
+        json_hash[attribute.to_s] = self.send(attribute).to_json if self.send(attribute)
+      end
+      json_hash.to_json(*a)
+    end
+        
     def self.attr_instance(method_name, options={})
        self.class_eval do
         name = method_name.to_s
@@ -38,6 +87,9 @@ module MageHand
         CODE
         puts code if ENV['DEBUG']
         module_eval code
+        
+        @@instance_attributes[self.name] = [] unless @@instance_attributes[self.name]
+        @@instance_attributes[self.name] << method_name
       end
     end
     

data/lib/ob_port/campaign.rb

@@ -3,18 +3,18 @@ module MageHand
     ROLES = {'game_master' => 'Game Master', 'player' => 'Player'}
     
     # public mini-object methods
-    attr_accessor :name, :campaign_url, :role, :visibility
+    attr_simple :name, :campaign_url, :role, :visibility
     
-    attr_accessor :slug
+    attr_simple :slug
     attr_instance :game_master, :class_name => 'User'
     inflate_if_nil :game_master, :slug
     
     # Private/Friends
-    attr_accessor :banner_image_url, :play_status, :looking_for_players, :created_at, :updated_at
+    attr_simple :banner_image_url, :play_status, :looking_for_players, :created_at, :updated_at
     inflate_if_nil :banner_image_url, :play_status, :looking_for_players, :created_at, :updated_at
     
     # Player/GM Only
-    attr_accessor :lat, :lng
+    attr_simple :lat, :lng
     inflate_if_nil :lat, :lng
     
     attr_array :players, :class_name => 'User'

data/lib/ob_port/user.rb

@@ -1,6 +1,6 @@
 module MageHand
   class User < Base
-    attr_accessor :username, :profile_url, :avatar_image_url,
+    attr_simple :username, :profile_url, :avatar_image_url,
       :created_at, :last_seen_at, :utc_offset, :locale, :is_ascendant
     inflate_if_nil :avatar_image_url, :created_at, :last_seen_at, :utc_offset,
       :locale, :is_ascendant

data/lib/ob_port/wiki_page.rb

@@ -3,19 +3,22 @@ module MageHand
     ROLES = {'game_master' => 'Game Master', 'player' => 'Player'}
     
     # public methods
-    attr_accessor :slug, :name, :wiki_page_url, :campaign, :created_at, :updated_at
+    attr_simple :slug, :name, :wiki_page_url, :created_at, :updated_at
     
     # Private/Friends
-    attr_accessor :type, :is_game_master_only, :body, :body_html, :tags
+    attr_simple :type, :is_game_master_only, :body, :body_html, :tags
     inflate_if_nil :body, :body_html
     
     # TODO Move these to the posts subclass when we have it.
-    attr_accessor :post_title, :post_tagline, :post_time
+    attr_simple :post_title, :post_tagline, :post_time
     
     # GM Only fields
-    attr_accessor :game_master_info, :game_master_info_markup
+    attr_simple :game_master_info, :game_master_info_markup
     inflate_if_nil :game_master_info, :game_master_info_markup
     
+    attr_instance :campaign
+    inflate_if_nil :campaign
+    
     def self.load_wiki_pages(campaign_id)
       wiki_hashes = JSON.parse(
         MageHand::get_client.access_token.get(collection_url(campaign_id)).body)
@@ -30,6 +33,30 @@ module MageHand
       type == 'Post'
     end
     
+    def to_hash
+      attribute_hash = {}
+      simple_attributes.each do |att|
+        attribute_hash[att] = self.send(att) unless self.send(att).nil?
+      end
+      
+      attribute_hash
+    end
+    
+    def to_json
+      to_hash.to_json
+    end
+    
+    def save!
+      if id # save existing wiki pae
+        
+      else # create new wiki page
+        json_body = {'wiki_page' => self.to_hash}.to_json
+        @response = MageHand.get_client.access_token.post(self.class.collection_url(self.campaign.id),
+          json_body,  {'content-type' => 'application/x-www-form-urlencoded'})
+        self.update_attributes!(JSON.parse(@response.body))
+      end
+    end
+    
     private
     
     def self.collection_url(campaign_id)

data/mage-hand.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mage-hand}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steven Hammond"]
-  s.date = %q{2011-10-24}
+  s.date = %q{2011-11-06}
   s.description = %q{mage-hand is a ghostly hand that reaches across the internet to access the Obsidian Portal API.}
   s.email = %q{shammond@northpub.com}
   s.extra_rdoc_files = [
@@ -35,9 +35,9 @@ Gem::Specification.new do |s|
     "lib/ob_port/wiki_page.rb",
     "mage-hand.gemspec",
     "test/helper.rb",
+    "test/test_base.rb",
     "test/test_campaign.rb",
-    "test/test_client.rb",
-    "test/test_mage-hand.rb"
+    "test/test_client.rb"
   ]
   s.homepage = %q{http://github.com/shammond42/mage-hand}
   s.licenses = ["MIT"]
@@ -46,9 +46,9 @@ Gem::Specification.new do |s|
   s.summary = %q{Ruby wrapper around the Obsidian Portal API}
   s.test_files = [
     "test/helper.rb",
+    "test/test_base.rb",
     "test/test_campaign.rb",
-    "test/test_client.rb",
-    "test/test_mage-hand.rb"
+    "test/test_client.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/test_base.rb

@@ -0,0 +1,55 @@
+require 'test/helper'
+
+class TestBase < Test::Unit::TestCase
+  context 'the Base class' do    
+    should 'use the attr_simple method to add an attribute' do
+      MageHand::Base.attr_simple :test_attribute, :second_attribute
+      @instance = MageHand::Base.new
+      @instance.test_attribute = 'Hello'
+      @instance.second_attribute = 'World'
+      assert_equal 'Hello', @instance.test_attribute
+      assert_equal 'World', @instance.second_attribute
+    end
+    
+    should 'be able to get a list of simple attributes' do
+      MageHand::Base.attr_simple :test_attribute, :second_attribute
+      @instance = MageHand::Base.new
+      
+      assert MageHand::Base.simple_attributes.include?(:test_attribute)
+      assert @instance.simple_attributes.include?(:test_attribute)
+      
+      assert MageHand::Base.simple_attributes.include?(:second_attribute)
+      assert @instance.simple_attributes.include?(:second_attribute)
+    end
+    
+    should 'be able to add an instance of another class as an attribute' do
+      MageHand::Base.attr_instance :test_campaign, :class_name => 'Campaign'
+      @instance = MageHand::Base.new
+      @instance.test_campaign = {:name => "A Great Time"}
+      assert_equal "A Great Time", @instance.test_campaign.name
+    end
+    
+    should 'be able to get a list of instance attributes' do
+      MageHand::Base.attr_instance :test_campaign, :class_name => 'Campaign'
+      @instance = MageHand::Base.new
+      
+      assert MageHand::Base.instance_attributes.include?(:test_campaign)
+      assert @instance.instance_attributes.include?(:test_campaign)
+    end
+    
+    should 'be able to get a list of all declared attributes' do
+      MageHand::Base.attr_instance :test_campaign, :class_name => 'Campaign'
+      MageHand::Base.attr_simple :test_attribute
+      @instance = MageHand::Base.new
+      
+      assert MageHand::Base.attributes.include?(:test_campaign)
+      assert @instance.attributes.include?(:test_campaign)
+      assert MageHand::Base.attributes.include?(:test_attribute)
+      assert @instance.attributes.include?(:test_attribute)
+    end
+    
+    should 'have id as a simple attribute' do
+      assert MageHand::Base.simple_attributes.include?(:id)
+    end    
+  end
+end

metadata

@@ -4,10 +4,10 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
+  - 4
+  - 0
   segments_generated: true
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors: 
 - Steven Hammond
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-24 00:00:00 -04:00
+date: 2011-11-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -214,9 +214,9 @@ files:
 - lib/ob_port/wiki_page.rb
 - mage-hand.gemspec
 - test/helper.rb
+- test/test_base.rb
 - test/test_campaign.rb
 - test/test_client.rb
-- test/test_mage-hand.rb
 has_rdoc: true
 homepage: http://github.com/shammond42/mage-hand
 licenses: 
@@ -251,6 +251,6 @@ specification_version: 3
 summary: Ruby wrapper around the Obsidian Portal API
 test_files: 
 - test/helper.rb
+- test/test_base.rb
 - test/test_campaign.rb
 - test/test_client.rb
-- test/test_mage-hand.rb

data/test/test_mage-hand.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestMageHand < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end