mage-hand 0.3.0 → 0.3.1

data/Gemfile

@@ -16,4 +16,5 @@ group :development do
   gem "rcov", ">= 0"
   gem "mocha", ">=0.9.8"
   gem "redgreen"
+  gem "webmock", ">=1.6.2"
 end

data/Gemfile.lock

@@ -2,6 +2,8 @@ GEM
   remote: http://rubygems.org/
   specs:
     activesupport (3.0.3)
+    addressable (2.2.4)
+    crack (0.1.8)
     git (1.2.5)
     i18n (0.4.2)
     jeweler (1.5.1)
@@ -16,6 +18,9 @@ GEM
     rcov (0.9.9)
     redgreen (1.2.2)
     shoulda (2.11.3)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
 
 PLATFORMS
   ruby
@@ -31,3 +36,4 @@ DEPENDENCIES
   rcov
   redgreen
   shoulda
+  webmock (>= 1.6.2)

data/TODO

@@ -0,0 +1,9 @@
+Campaigns:
+  Handle location properly
+  Should be able to initialize from a json string or an attribute hash
+  
+Look at REE singularize of Campaign vs. Campaign(s)
+
+Fix instructions
+
+  

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lib/mage-hand.rb

@@ -8,11 +8,20 @@ require 'ob_port/campaign'
 require 'ob_port/wiki_page'
 
 module MageHand
+  def self.set_app_keys(app_key, app_secret)
+    Client.set_app_keys(app_key, app_secret)
+  end
+  
+  def self.get_client(session_request_token=nil, session_access_token_key=nil, session_access_token_secret=nil,
+      callback=nil, params=nil)
+    Client.get_client(session_request_token, session_access_token_key, session_access_token_secret,
+          callback, params)
+  end
   
   protected
   
   def obsidian_portal_login_required
-    @mage_client = MageHand::Client.new(session[:request_token], session[:access_token_key], 
+    @mage_client = Client.get_client(session[:request_token], session[:access_token_key], 
       session[:access_token_secret], request.url, params)
     store_tokens
     return true if logged_in?

data/lib/ob_port/base.rb

@@ -15,13 +15,31 @@ module MageHand
     end
     
     def inflate
-      hash = JSON.parse( MageHand::client.access_token.get(individual_url).body)
+      hash = JSON.parse( MageHand::get_client.access_token.get(individual_url).body)
       update_attributes!(hash)
     end
     
     def self.model_name
       @_model_name ||= ActiveModel::Name.new(self)
     end
+
+    def self.attr_instance(method_name, options={})
+       self.class_eval do
+        name = method_name.to_s
+        class_name = options[:class_name] || name.classify
+        code = <<-CODE
+          def #{name}
+            @#{name}
+          end
+
+          def #{name}=(new_#{name})
+            @#{name} = #{class_name}.new(new_#{name.singularize})
+          end
+        CODE
+        puts code if ENV['DEBUG']
+        module_eval code
+      end
+    end
     
     def self.attr_array(method_name, options={})
       self.class_eval do
@@ -39,7 +57,7 @@ module MageHand
             end
           end
         CODE
-        puts code
+        puts code if ENV['DEBUG']
         module_eval code
       end
     end

data/lib/ob_port/campaign.rb

@@ -5,8 +5,9 @@ module MageHand
     # public mini-object methods
     attr_accessor :name, :campaign_url, :role, :visibility
     
-    attr_accessor :game_master_id, :slug
-    inflate_if_nil :game_master_id, :slug
+    attr_accessor :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
@@ -18,6 +19,16 @@ module MageHand
     
     attr_array :players, :class_name => 'User'
     inflate_if_nil :players
+
+    def self.find_by_slug(slug)
+      hash = JSON.parse( MageHand::get_client.access_token.get("/v1/campaigns/#{slug}.json?use_slug=true").body)
+      Campaign.new(hash)
+    end
+
+    def self.find(id)
+      hash = JSON.parse( MageHand::get_client.access_token.get("/v1/campaigns/#{id}.json").body)
+      Campaign.new(hash)
+    end
     
     def looking_for_players?
       looking_for_players
@@ -35,7 +46,7 @@ module MageHand
        @adventure_logs ||= wiki_pages.select{|page| page.is_post?}
      end
      
-     private
+     protected
 
      def individual_url
        "/v1/campaigns/#{self.id}.json"

data/lib/ob_port/client.rb

@@ -1,12 +1,23 @@
 module MageHand
   class Client
     attr_accessor :request_token, :access_token_key, :access_token_secret
+    @@client = nil
     
-    def self.configure(key, secret)
+    def self.set_app_keys(key, secret)
       @@key = key
       @@secret = secret
     end
-        
+    
+    def self.get_client(session_request_token=nil, session_access_token_key=nil, session_access_token_secret=nil,
+        callback=nil, params=nil)
+      # If we don't have a client, or we are changing a token, initialize a new client
+      if !@@client || session_request_token || session_access_token_key || session_access_token_secret
+        @@client = Client.new(session_request_token, session_access_token_key,
+          session_access_token_secret, callback, params)
+      end
+      @@client
+    end
+    
     def initialize(session_request_token=nil, session_access_token_key=nil, session_access_token_secret=nil,
         callback=nil, params=nil)
       @request_token = session_request_token
@@ -47,5 +58,11 @@ module MageHand
     def campaign(id)
       MageHand::Campaign.new(JSON.parse(access_token.get("/v1/campaigns/#{id}.json").body))
     end
+    
+    protected
+    
+    def self.reset_client
+      @@client = nil
+    end
   end
 end

data/lib/ob_port/user.rb

@@ -7,7 +7,7 @@ module MageHand
 
     alias :is_ascendant? :is_ascendant
 
-    attr_array :campaigns
+    attr_array :campaigns #, :class_name => 'Campaign'
     inflate_if_nil :campaigns
     
     private

data/lib/ob_port/wiki_page.rb

@@ -10,7 +10,7 @@ module MageHand
     inflate_if_nil :body, :body_html
     
     # TODO Move these to the posts subclass when we have it.
-    attr_accessor :post_title, :post_taglines, :post_time
+    attr_accessor :post_title, :post_tagline, :post_time
     
     # GM Only fields
     attr_accessor :game_master_info, :game_master_info_markup
@@ -18,7 +18,7 @@ module MageHand
     
     def self.load_wiki_pages(campaign_id)
       wiki_hashes = JSON.parse(
-        MageHand::client.access_token.get(collection_url(campaign_id)).body)
+        MageHand::get_client.access_token.get(collection_url(campaign_id)).body)
       wiki_hashes.map {|hash| WikiPage.new(hash)}
     end
     

data/mage-hand.gemspec

@@ -5,16 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mage-hand}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Steven Hammond"]
-  s.date = %q{2011-03-03}
+  s.date = %q{2011-06-07}
   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 = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.rdoc",
+    "TODO"
   ]
   s.files = [
     ".document",
@@ -23,6 +24,7 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
+    "TODO",
     "VERSION",
     "lib/mage-hand.rb",
     "lib/ob_port/base.rb",
@@ -32,6 +34,7 @@ Gem::Specification.new do |s|
     "lib/ob_port/wiki_page.rb",
     "mage-hand.gemspec",
     "test/helper.rb",
+    "test/test_campaign.rb",
     "test/test_client.rb",
     "test/test_mage-hand.rb"
   ]
@@ -42,6 +45,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Ruby wrapper around the Obsidian Portal API}
   s.test_files = [
     "test/helper.rb",
+    "test/test_campaign.rb",
     "test/test_client.rb",
     "test/test_mage-hand.rb"
   ]
@@ -61,6 +65,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rcov>, [">= 0"])
       s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
       s.add_development_dependency(%q<redgreen>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 1.6.2"])
       s.add_runtime_dependency(%q<oauth>, [">= 0.4.4"])
     else
       s.add_dependency(%q<oauth>, [">= 0.4.4"])
@@ -73,6 +78,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rcov>, [">= 0"])
       s.add_dependency(%q<mocha>, [">= 0.9.8"])
       s.add_dependency(%q<redgreen>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 1.6.2"])
       s.add_dependency(%q<oauth>, [">= 0.4.4"])
     end
   else
@@ -86,6 +92,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rcov>, [">= 0"])
     s.add_dependency(%q<mocha>, [">= 0.9.8"])
     s.add_dependency(%q<redgreen>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 1.6.2"])
     s.add_dependency(%q<oauth>, [">= 0.4.4"])
   end
 end

data/test/helper.rb

@@ -11,6 +11,7 @@ end
 require 'test/unit'
 require 'shoulda'
 require 'mocha'
+require 'webmock/test_unit'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_campaign.rb

@@ -0,0 +1,44 @@
+require 'test/helper'
+
+class TestCampaign < Test::Unit::TestCase
+  context 'an instance of the Campaign class' do
+    should 'know its url' do
+      id_string = 'asdf12341asdf1234'
+      campaign = MageHand::Campaign.new(:id => id_string)
+      assert_equal "/v1/campaigns/#{id_string}.json", campaign.send(:individual_url)
+    end
+  end
+  
+  context 'the Campaign class' do
+    setup do
+      @mini_fields = {
+        :id => 'asdf12341asdf1234',
+        :name => 'Fellowship of the Ring',
+        :campaign_url => 'http://www.obsidianportal.com/campaigns/fellowship-of-the-ring',
+        :visibility => 'public',
+        :role => 'player'
+      }
+      @full_fields = @mini_fields.merge(
+        :slug => 'FotR',
+        :play_status => 'active',
+        :looking_for_players => false
+      )
+    end
+    
+    should 'be able to initialize from a mini object' do
+      campaign = MageHand::Campaign.new(@mini_fields)
+      assert_not_nil campaign
+      @mini_fields.each do |key, value|
+        assert_equal campaign.send(key), value
+      end
+    end
+    
+    should 'be able to initialize from a complete object' do
+      campaign = MageHand::Campaign.new(@full_fields)
+      assert_not_nil campaign
+      @full_fields.each do |key, value|
+        assert_equal campaign.send(key), value
+      end     
+    end
+  end
+end

data/test/test_client.rb

@@ -3,7 +3,7 @@ require 'helper'
 class TestClient < Test::Unit::TestCase
   context "The Obsidian Portal client" do
     should "configure correctly with a key and secret" do
-      assert_nothing_raised {MageHand::Client.configure('asdfasdf','asdfasdfasdfasdfasdf')} 
+      assert_nothing_raised {MageHand::Client.set_app_keys('asdfasdf','asdfasdfasdfasdfasdf')} 
     end
   end
   
@@ -19,29 +19,30 @@ class TestClient < Test::Unit::TestCase
       OAuth::AccessToken.any_instance.stubs(:post).returns(response)
       OAuth::Consumer.any_instance.stubs(:get_request_token).returns(@request_token)
       
-      MageHand::Client.configure('asdfasdf', 'asdfasdfasdfasdfasdf')  
+      MageHand::Client.send(:reset_client)
+      MageHand::Client.set_app_keys('asdfasdf', 'asdfasdfasdfasdfasdf')  
     end
     should "be configured to use different urls for authentication and api access" do
-      @client = MageHand::Client.new(nil, nil, nil)
+      @client = MageHand::get_client(nil, nil, nil)
       assert @client.consumer.site =~ /api\.obsidianportal\.com/
       assert @client.consumer.request_token_url =~ /https:\/\/www\.obsidianportal\.com/
       assert @client.consumer.authorize_url =~ /https:\/\/www\.obsidianportal\.com/
       assert @client.consumer.access_token_url =~ /https:\/\/www\.obsidianportal\.com/
     end
     should "have a request_token, and not an access token, when authorizing" do
-      @client = MageHand::Client.new(nil, nil, nil)
+      @client = MageHand::get_client(nil, nil, nil)
       assert_not_nil @client
       assert_equal @client.request_token, @request_token
       assert_nil @client.access_token
     end
     should "create an access_token when an oauth_verifier and request_token is passed in" do
-      @client = MageHand::Client.new(@request_token, nil, nil, nil, {:oauth_verifier => 'asdfasdf'})
+      @client = MageHand::get_client(@request_token, nil, nil, nil, {:oauth_verifier => 'asdfasdf'})
       assert_not_nil @client
       assert_not_nil @client.access_token
       assert @client.logged_in?
     end
     should "be logged in if initialized with an access_key and access_secret" do
-      @client = MageHand::Client.new(nil, 'asdf', 'asdfasdfasdfasdf')
+      @client = MageHand::get_client(nil, 'asdf', 'asdfasdfasdfasdf')
       assert_not_nil @client
       assert @client.logged_in?
       assert_equal @client.access_token.token, 'asdf'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mage-hand
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Steven Hammond
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-03 00:00:00 -05:00
+date: 2011-06-07 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -169,6 +169,22 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   prerelease: false
   version_requirements: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 6
+        - 2
+        version: 1.6.2
+  name: webmock
+  requirement: *id011
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id012 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -180,7 +196,7 @@ dependencies:
         - 4
         version: 0.4.4
   name: oauth
-  requirement: *id011
+  requirement: *id012
   type: :runtime
 description: mage-hand is a ghostly hand that reaches across the internet to access the Obsidian Portal API.
 email: shammond@northpub.com
@@ -191,6 +207,7 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE.txt
 - README.rdoc
+- TODO
 files: 
 - .document
 - Gemfile
@@ -198,6 +215,7 @@ files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
+- TODO
 - VERSION
 - lib/mage-hand.rb
 - lib/ob_port/base.rb
@@ -207,6 +225,7 @@ files:
 - lib/ob_port/wiki_page.rb
 - mage-hand.gemspec
 - test/helper.rb
+- test/test_campaign.rb
 - test/test_client.rb
 - test/test_mage-hand.rb
 has_rdoc: true
@@ -245,5 +264,6 @@ specification_version: 3
 summary: Ruby wrapper around the Obsidian Portal API
 test_files: 
 - test/helper.rb
+- test/test_campaign.rb
 - test/test_client.rb
 - test/test_mage-hand.rb