riaction 0.4.2 → 0.5.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG #
 
+## 0.5.0 ##
+
+* Added ability to specify a display name for a profile.  new feature; all existing features work the same.
+
+
 ## 0.4.2 ##
 
 * Fixed NameError bug in tasks. For realsies.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    riaction (0.2.0)
+    riaction (0.4.2)
       activerecord (>= 3.0.0)
       activesupport (>= 3.0.0)
       faraday

data/README.md

@@ -52,6 +52,13 @@ Models in your application may declare themselves as profiles that exist on IAct
   
 Here, the class User declares itself as a profile of type "player", identifiable by two of IActionable's supported identifier types, username and custom.  The values of these identifiers are the fields nickname and id, respectively, and can be any method that an instance of the class responds to.  When a class declares itself as a riaction profile, an after_create callback will be added to create the profile on IActionable with the identifiers declared in the class.
 
+An optional display name can be given, which should be a method that the object responds to:
+
+    class User < ActiveRecord::Base
+      riaction :profile, :type => :player, :username => :nickname, :custom => :id, :display_name => :nickname
+    end
+  
+
 #### Profile Instance Methods ####
 
 Classes that declare themselves as IActionable profiles are given instance methods that tie in to the IActionable API, as many uses of the API treat the profile as a top-level resource.

data/lib/riaction/riaction.rb

@@ -81,9 +81,9 @@ module Riaction
           true
         end
       end
-    
+      
       # store the profile
-      riaction_profiles.store(type, fields)
+      riaction_profiles.store(type, {:display_name_method => fields.delete(:display_name), :identifiers => fields})
     end
   
     def riaction_profile?
@@ -182,10 +182,10 @@ module Riaction
       def riaction_profile_keys(profile_type=nil, id_type=nil)
         if self.class.riaction_profiles.size > 0
           if profile_type && self.class.riaction_profiles.has_key?(profile_type)
-            ids = self.class.riaction_profiles.fetch(profile_type)
+            ids = self.class.riaction_profiles.fetch(profile_type)[:identifiers]
           else
             profile_type = self.class.riaction_profiles.first[0]
-            ids = self.class.riaction_profiles.first[1]
+            ids = self.class.riaction_profiles.first[1][:identifiers]
           end
       
           if id_type && ids.has_key?(id_type)
@@ -199,6 +199,34 @@ module Riaction
       rescue KeyError, NoMethodError => e
         {}
       end
+      
+      def riaction_profile_display_name(profile_type=nil)
+        if self.class.riaction_profiles.size > 0
+          if profile_type && self.class.riaction_profiles.has_key?(profile_type)
+            method = self.class.riaction_profiles.fetch(profile_type)[:display_name_method]
+          else
+            method = self.class.riaction_profiles.first[1][:display_name_method]
+          end
+      
+          if method
+            if method.kind_of? Symbol
+              begin
+                self.send(method)
+              rescue NoMethodError => e
+                nil
+              end
+            else
+              nil
+            end
+          else
+            nil
+          end
+        else
+          nil
+        end
+      rescue KeyError, NoMethodError => e
+        nil
+      end
     
       #################
       #  API wrappers #
@@ -222,7 +250,7 @@ module Riaction
           existing = riaction_profile_summary
           unless existing
             @iactionable_api ||= IActionable::Api.new
-            @iactionable_api.create_profile(keys[:profile_type], keys[:id_type], keys[:id])
+            @iactionable_api.create_profile(keys[:profile_type], keys[:id_type], keys[:id], riaction_profile_display_name)
           else
             existing
           end

data/lib/riaction/version.rb

@@ -1,3 +1,3 @@
 module Riaction
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/spec/riaction_spec.rb

@@ -48,7 +48,7 @@ describe Riaction do
             riaction :profile, :type => :user, :custom => :id
           end
           RiactionClass.riaction_profile?.should be_true
-          hash_including(:custom => :id).should == RiactionClass.riaction_profiles[:user]
+          hash_including(:custom => :id).should == RiactionClass.riaction_profiles[:user][:identifiers]
         end
       end
       
@@ -280,7 +280,7 @@ describe Riaction do
         super
       end
       
-      riaction :profile, :type => :user, :custom => :id, :username => :name
+      riaction :profile, :type => :user, :display_name => :full_name, :custom => :id, :username => :name
       
       def id
         42
@@ -289,6 +289,10 @@ describe Riaction do
       def name
         "zortnac"
       end
+      
+      def full_name
+        "zortnac pah"
+      end
     end
     
     describe "creation triggering" do
@@ -312,9 +316,9 @@ describe Riaction do
       end
       
       describe "for creating a profile" do
-        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance" do
+        it "should make the correct call to the API with the parameters given in the class, and the values provided by the instance, including the display name" do
           @api.stub!(:get_profile_summary).and_return(nil)
-          @api.should_receive(:create_profile).once.with("user", "custom", @instance.id.to_s).and_return(@mock_response)
+          @api.should_receive(:create_profile).once.with("user", "custom", @instance.id.to_s, @instance.full_name).and_return(@mock_response)
           @instance.riaction_create_profile.should == @mock_response
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riaction
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-21 00:00:00.000000000Z
+date: 2012-01-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2161189540 !ruby/object:Gem::Requirement
+  requirement: &2160485300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2161189540
+  version_requirements: *2160485300
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2161189120 !ruby/object:Gem::Requirement
+  requirement: &2160484880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161189120
+  version_requirements: *2160484880
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &2161188660 !ruby/object:Gem::Requirement
+  requirement: &2160484420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161188660
+  version_requirements: *2160484420
 - !ruby/object:Gem::Dependency
   name: faraday-stack
-  requirement: &2161188240 !ruby/object:Gem::Requirement
+  requirement: &2160484000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161188240
+  version_requirements: *2160484000
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &2161187740 !ruby/object:Gem::Requirement
+  requirement: &2160483440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2161187740
+  version_requirements: *2160483440
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2161187240 !ruby/object:Gem::Requirement
+  requirement: &2160482900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2161187240
+  version_requirements: *2160482900
 - !ruby/object:Gem::Dependency
   name: resque
-  requirement: &2161186860 !ruby/object:Gem::Requirement
+  requirement: &2160482360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2161186860
+  version_requirements: *2160482360
 description: Wrapper for IActionable's restful API and an "acts-as" style interface
   for models to behave as profiles and drive game events.
 email: