geni 0.0.5 → 0.0.6

data/.gitignore

@@ -4,4 +4,5 @@ Thumbs.db
 *.gem
 .rvmrc
 ~*
-test.rb
+test.rb
+notes.txt

data/README.md

@@ -33,12 +33,17 @@ Simple Ruby client to the [Geni](http://www.geni.com) REST/OAuth API.
       puts profile.name
     end
 
+Support is available for profiles, documents, photos, projects, unions, videos.
+
 I've also put [a demo Rails app](https://github.com/aurels/geni-rails-example) online to show the usage of the gem with Rails or Sinatra.
 
-# Not done yet
+# Tests
+
+To run the specs :
+
+    $ rake spec
 
-+ This gem needs some specs
-+ This gem only access profile and immediate family information.  I don't have a paid account, I cannot implement everything now.
+All request responses are stubbed via Faraday in `spec/support/mocked_responses`.
 
 # Feedback and help
 

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+task :default => :spec

data/geni.gemspec

@@ -2,10 +2,10 @@
 
 Gem::Specification.new do |s|
   s.name = %q{geni}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aurélien Malisart","Matt Johnston"]
+  s.authors = ["Aurélien Malisart", "Matt Johnston"]
   s.date = %q{2011-02-03}
   s.description = %q{A Ruby client to the geni.com API}
   s.email = %q{aurelien.malisart@gmail.com}
@@ -15,19 +15,8 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   
-  s.files = [
-    ".gitignore",
-     "README.md",
-     "lib/geni.rb",
-     "lib/array_hacks.rb",
-     "lib/oauth_hacks.rb",
-     "lib/geni/base.rb",
-     "lib/geni/client.rb",
-     "lib/geni/family.rb",
-     "lib/geni/profile.rb",
-     "geni.gemspec",
-     "LICENSE"
-  ]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.homepage = %q{http://github.com/aurels/geni}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ['lib']
@@ -40,5 +29,8 @@ Gem::Specification.new do |s|
     s.specification_version = 3
     s.add_dependency(%q<oauth2>, ["= 0.1.1"])
     s.add_dependency(%q<json>, ["= 1.5.0"])
+    
+    s.add_development_dependency("rake", "~> 0.8.7")
+    s.add_development_dependency("rspec", "2.5.0")
   end
 end

data/lib/geni.rb

@@ -1,7 +1,13 @@
 require 'oauth2'
 require 'oauth_hacks'
 require 'array_hacks'
-require 'geni/client'
+
 require 'geni/base'
+require 'geni/taggable'
 require 'geni/profile'
-require 'geni/family'
+require 'geni/union'
+require 'geni/project'
+require 'geni/photo'
+require 'geni/document'
+require 'geni/video'
+require 'geni/client'

data/lib/geni/base.rb

@@ -1,12 +1,39 @@
 module Geni
   class Base
-    attr_reader :client
-    
+    attr_reader :id, :client
+
     def initialize(params = {})
+      @id = params[:id]
       @client = params[:client]
-      params[:attrs].each_pair do |attr, value|
+      @fetched = params[:fetched] || false
+      
+      if params.has_key?(:attrs)
+        params[:attrs].each_pair do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+    
+    def fetched?
+      @fetched
+    end
+    
+    def fetch
+      client.access_token.get("/api/#{id}").each_pair do |attr, value|
         instance_variable_set("@#{attr}".to_sym, value)
       end
+      @fetched = true
+    end
+    
+    class << self
+      def has_fetchable_attributes(attribute_names)
+        attribute_names.each do |attribute_name|
+          define_method "#{attribute_name}" do
+            self.fetch unless self.fetched?
+            instance_variable_get("@#{attribute_name}")
+          end
+        end
+      end
     end
   end
 end

data/lib/geni/client.rb

@@ -18,33 +18,55 @@ module Geni
       
       @access_token = OAuth2::AccessToken.new(oauth_client, params[:token])
     end
+            
+    TYPES = {
+      'profile'  => Geni::Profile,
+      'union'    => Geni::Union,
+      'project'  => Geni::Project,
+      'photo'    => Geni::Photo,
+      'document' => Geni::Document,
+      'video'    => Geni::Video
+    }
     
-    def get_profile(id_or_ids = nil)
-      if id_or_ids.nil?
-        url = "/api/profile"
-      elsif id_or_ids.kind_of?(Array)
-        if id_or_ids.any?
-          url = "/api/profile-#{id_or_ids.join(',')}"
-        else
-          return []
-        end
-      else
-        url = "/api/profile-#{id_or_ids}"
+    TYPES.each_pair do |type, klass|
+      define_method "get_#{type}" do |id|
+        entity = klass.new({
+          :client => self,
+          :id     => id
+        })
       end
-            
-      results = access_token.get(url)
-      results = results['results'] if results.has_key?('results')
+    end
+    
+    def get_profiles(ids)
+      return [] if ids.empty?
+      return [get_profile(ids.first)] if ids.one?
+      
+      numbers = ids.collect { |id| id.gsub(/profile-/, '') }.join(',')
+      url = "/api/profile-#{numbers}"
+      results = access_token.get(url)['results']
       
-      profiles = [results].flatten.collect do |profile_attrs|
+      results.collect do |profile_attrs|
         Geni::Profile.new({
-          :client => self,
-          :attrs  => profile_attrs
+          :client  => self,
+          :attrs   => profile_attrs,
+          :fetched => true
         })
       end
-      
-      id_or_ids.kind_of?(Array) ? profiles : profiles.first
     end
     
+    def me
+      Geni::Profile.new({
+        :client  => self,
+        :attrs   => access_token.get('/api/profile'),
+        :fetched => true
+      })
+    end
+    
+    def [](entity_id)
+      entity_type = entity_id.split('-').first
+      send("get_#{entity_type}", entity_id)
+    end
+        
     def redirect_uri(request)
       uri = URI.parse(request.url)
       uri.path = @callback

data/lib/geni/document.rb

@@ -0,0 +1,9 @@
+module Geni
+  class Document < Base
+    has_fetchable_attributes %w[
+      title url date date_parts content_type description sizes
+    ]
+  
+    include Taggable
+  end
+end

data/lib/geni/photo.rb

@@ -0,0 +1,10 @@
+module Geni
+  class Photo < Base
+    
+    has_fetchable_attributes %w[
+      title url date date_parts content_type sizes album_id created_on
+    ]
+    
+    include Taggable
+  end
+end

data/lib/geni/profile.rb

@@ -1,36 +1,22 @@
+require 'geni/profile/immediate_family'
+
 module Geni
   class Profile < Base
-    attr_reader :id
-    attr_reader :first_name
-    attr_reader :middle_name
-    attr_reader :maiden_name
-    attr_reader :last_name
-    attr_reader :suffix
-    attr_reader :display_name
-    attr_reader :name
-    attr_reader :gender
-    attr_reader :current_residence
-    attr_reader :created_by
-    attr_reader :managers
-    attr_reader :merged_into
-    attr_reader :requested_merges
-    attr_reader :merge_note
-    attr_reader :public
-    attr_reader :big_tree
-    attr_reader :claimed
-    attr_reader :locked
-    attr_reader :birth_date
-    attr_reader :birth_location
-    attr_reader :birth_location
-    attr_reader :death_date
-    attr_reader :death_location
-    attr_reader :burial_date
-    attr_reader :url
-    attr_reader :language
-    attr_reader :curator
-    attr_reader :mugshot_urls
-    attr_reader :birth_date_parts
-    attr_reader :relationship
+
+    has_fetchable_attributes %w[
+      first_name middle_name maiden_name last_name suffix display_name name gender
+      current_residence created_by merge_note public big_tree claimed locked birth_date
+      borth_date_parts birth_location baptism_date baptism_date_parts baptism_location
+      death_date death_date_parts death_location burial_date blurial_date_parts blurial_location
+      url language mugshot_urls relationship is_alive
+    ]
+
+    def immediate_family
+      @immediate_family ||= Geni::Profile::ImmediateFamily.new({
+        :client => client,
+        :attrs  => client.access_token.get("/api/#{id}/immediate-family")
+      })
+    end
     
     def parents
       immediate_family.parents
@@ -55,12 +41,57 @@ module Geni
     def partners
       immediate_family.partners
     end
-
-    def immediate_family
-      @immediate_family ||= Geni::Family.new({
-        :client => client,
-        :attrs  => client.access_token.get("/api/profile-#{id}/immediate-family")
-      })
+    
+    def managers
+      @manager_profiles ||= @managers.collect do |profile_link|
+        client.get_profile(profile_link.split('-').last)
+      end
+    end
+    
+    def merged_into
+      @merged_into_profiles ||= @merged_into.to_a.collect do |profile_link|
+        client.get_profile(profile_link.split('-').last)
+      end
+    end
+    
+    def requested_merges
+      @requested_merges_profiles ||= @requested_merges.to_a.collect do |profile_link|
+        client.get_profile(profile_link.split('-').last)
+      end
+    end
+    
+    def curator
+      @curator_profile ||= @curator.nil? ? nil : client.get_profile(@curator.split('/').last)
+    end
+        
+    def photos
+      @photos ||= client.access_token.get("/api/#{id}/photos")['results'].to_a.collect do |photo_attrs|
+        Geni::Photo.new({
+          :client  => client,
+          :attrs   => photo_attrs,
+          :fetched => true
+        })
+      end
+    end
+    
+    def videos
+      @videos ||= client.access_token.get("/api/#{id}/videos")['results'].to_a.collect do |video_attrs|
+        Geni::Photo.new({
+          :client  => client,
+          :attrs   => video_attrs,
+          :fetched => true
+        })
+      end
+    end
+    
+    def documents
+      @documents ||= client.access_token.get("/api/#{id}/documents")['results'].collect do |documents_attrs|
+        Geni::Photo.new({
+          :client  => client,
+          :attrs   => documents_attrs,
+          :fetched => true
+        })
+      end
     end
   end
 end

data/lib/geni/profile/immediate_family.rb

@@ -0,0 +1,51 @@
+module Geni
+  class Profile < Base
+    class ImmediateFamily
+      attr_reader :client, :focus
+
+      def initialize(params)
+        @client = params[:client]
+
+        params[:attrs].each_pair do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      def parents
+        @parents ||= profiles(walk(focus_node, ['child', 'partner']))
+      end
+
+      def partners
+        @partners ||= profiles(walk(focus_node, ['partner', 'partner']))
+      end
+
+      def children
+        @children ||= profiles(walk(focus_node, ['partner', 'child']))
+      end
+
+      def siblings
+        @siblings ||= profiles(walk(focus_node, ['child', 'child']))
+      end
+
+      protected
+
+      def focus_node
+        @nodes[@focus['id']]
+      end
+
+      def walk(node, rels)
+        return node if rels.empty?
+
+        node['edges'].collect do |edge_id, edge|
+          if edge['rel'] == rels.first && edge_id != @focus['id'] 
+            walk(@nodes[edge_id], rels.tail)
+          end
+        end.compact.flatten
+      end
+
+      def profiles(nodes)
+        client.get_profiles(nodes.collect { |node| node['id'] })
+      end
+    end
+  end
+end

data/lib/geni/project.rb

@@ -0,0 +1,19 @@
+module Geni
+  class Project < Base
+    has_fetchable_attributes %w[name description url]
+    
+    ['collaborators', 'profiles', 'followers'].each do |relation_name|
+      define_method relation_name do
+        if instance_variable_get("@#{relation_name}").nil?
+          profile_ids = client.access_token.get("/api/#{id}/#{relation_name}")['results'].collect do |profile|
+            profile['id'].split('-').last
+          end
+          
+          instance_variable_set("@#{relation_name}", client.get_profiles(profile_ids))
+        else
+          instance_variable_get("@#{relation_name}")
+        end
+      end
+    end
+  end
+end

data/lib/geni/taggable.rb

@@ -0,0 +1,27 @@
+module Geni
+  module Taggable
+    def tags
+      return @tags if @tags
+      
+      response_hash = client.access_token.get("/api/#{id}/tags")
+      
+      if response_hash.has_key?('results')
+        profile_ids = response_hash['results'].collect do |profile|
+          profile['id']
+        end
+
+        @tags = client.get_profiles(profile_ids)
+      else
+        @tags = []
+      end
+    end
+    
+    def tag
+      raise NotImplementedError
+    end
+    
+    def untag
+      raise NotImplementedError
+    end
+  end
+end