nelumba 0.0.13

data/lib/nelumba/person.rb

@@ -0,0 +1,306 @@
+require 'nelumba/activity'
+
+module Nelumba
+  require 'atom'
+
+  # Holds information about the author of the Feed.
+  class Person
+    require 'date'
+
+    # Holds the id that represents this contact.
+    attr_reader :uid
+
+    # Holds the nickname of this contact.
+    attr_reader :nickname
+
+    # Holds a hash representing information about the name of this contact.
+    #
+    # contains one or more of the following:
+    #   :formatted         => The full name of the contact
+    #   :family_name       => The family name. "Last name" in Western contexts.
+    #   :given_name        => The given name. "First name" in Western contexts.
+    #   :middle_name       => The middle name.
+    #   :honorific_prefix  => "Title" in Western contexts. (e.g. "Mr." "Mrs.")
+    #   :honorific_suffix  => "Suffix" in Western contexts. (e.g. "Esq.")
+    attr_reader :extended_name
+
+    # The uri that uniquely identifies the author.
+    attr_reader :uri
+
+    # The email address of the author.
+    attr_reader :email
+
+    # The name of the author
+    attr_reader :name
+
+    # Holds a hash representing the address of the contact.
+    #
+    # contains one or more of the following:
+    #   :formatted      => A formatted representating of the address. May
+    #                     contain newlines.
+    #   :street_address => The full street address. May contain newlines.
+    #   :locality       => The city or locality component.
+    #   :region         => The state or region component.
+    #   :postal_code    => The zipcode or postal code component.
+    #   :country        => The country name component.
+    attr_reader :address
+
+    # Holds a hash representing an organization for this contact.
+    #
+    # contains one or more of the following:
+    #   :name        => The name of the organization (e.g. company, school,
+    #                   etc) This field is required. Will be used for sorting.
+    #   :department  => The department within the organization.
+    #   :title       => The title or role within the organization.
+    #   :type        => The type of organization. Canonical values include
+    #                   "job" or "school"
+    #   :start_date  => A DateTime representing when the contact joined
+    #                   the organization.
+    #   :end_date    => A DateTime representing when the contact left the
+    #                   organization.
+    #   :location    => The physical location of this organization.
+    #   :description => A free-text description of the role this contact
+    #                   played in this organization.
+    attr_reader :organization
+
+    # Holds a hash representing information about an account held by this
+    # contact.
+    #
+    # contains one or more of the following:
+    #   :domain   => The top-most authoriative domain for this account. (e.g.
+    #                "twitter.com") This is the primary field. Is required.
+    #                Used for sorting.
+    #   :username => An alphanumeric username, typically chosen by the user.
+    #   :userid   => A user id, typically assigned, that uniquely refers to
+    #                the user.
+    attr_reader :account
+
+    # Holds the gender of this contact.
+    attr_reader :gender
+
+    # Holds the requested pronouns.
+    #
+    # contains one or more of the following:
+    #   :plural     => Whether or not the actor is considered plural
+    #   :personal   => Personal pronoun (xe)
+    #   :possessive => Possessive pronoun (her)
+    attr_reader :pronoun
+
+    # Holds a note for this contact.
+    attr_reader :note
+
+    # Holds the display name for this contact.
+    attr_reader :display_name
+
+    # Holds the preferred username of this contact.
+    attr_reader :preferred_username
+
+    # Holds a DateTime that represents when this contact was last modified.
+    attr_reader :updated
+
+    # Holds a DateTime that represents when this contact was originally
+    # published.
+    attr_reader :published
+
+    # Holds a DateTime representing this contact's birthday.
+    attr_reader :birthday
+
+    # Holds a DateTime representing a contact's anniversary.
+    attr_reader :anniversary
+
+    # Creates a representating of an author.
+    #
+    # options:
+    #   name               => The name of the author. Defaults: "anonymous"
+    #   uid                => The identifier that uniquely identifies the
+    #                         contact.
+    #   nickname           => The nickname of the contact.
+    #   gender             => The gender of the contact.
+    #   note               => A note for this contact.
+    #   display_name       => The display name for this contact.
+    #   preferred_username => The preferred username for this contact.
+    #   updated            => A DateTime representing when this contact was
+    #                         last updated.
+    #   published          => A DateTime representing when this contact was
+    #                         originally created.
+    #   birthday           => A DateTime representing a birthday for this
+    #                         contact.
+    #   anniversary        => A DateTime representing an anniversary for this
+    #                         contact.
+    #   extended_name      => A Hash representing the name of the contact.
+    #   organization       => A Hash representing the organization of which the
+    #                         contact belongs.
+    #   account            => A Hash describing the authorative account for the
+    #                         author.
+    #   address            => A Hash describing the address of the contact.
+    #   uri                => The uri that uniquely identifies this author.
+    #   email              => The email of the author.
+    def initialize(options = {})
+      init(options)
+    end
+
+    def init(options = {})
+      @uri                = options[:uri]
+      @name               = options[:name] || "anonymous"
+      @email              = options[:email]
+
+      @uid                = options[:uid]
+      @name               = options[:name]
+      @gender             = options[:gender]
+      @note               = options[:note]
+      @nickname           = options[:nickname]
+      @display_name       = options[:display_name]
+      @preferred_username = options[:preferred_username]
+      @updated            = options[:updated]
+      @published          = options[:published]
+      @birthday           = options[:birthday]
+      @anniversary        = options[:anniversary]
+
+      @pronoun            = options[:pronoun] || {}
+
+      @extended_name      = options[:extended_name]
+      @organization       = options[:organization]
+      @account            = options[:account]
+      @address            = options[:address]
+    end
+
+    def to_hash
+      {
+        :uri                => self.uri,
+        :email              => self.email,
+        :name               => self.name,
+
+        :uid                => self.uid,
+        :gender             => self.gender,
+        :note               => self.note,
+        :nickname           => self.nickname,
+        :display_name       => self.display_name,
+        :preferred_username => self.preferred_username,
+        :updated            => self.updated,
+        :published          => self.published,
+        :birthday           => self.birthday,
+        :anniversary        => self.anniversary,
+
+        :pronoun            => self.pronoun,
+
+        :extended_name      => self.extended_name,
+        :organization       => self.organization,
+        :account            => self.account,
+        :address            => self.address
+      }
+    end
+
+    def to_json_hash
+      {
+        :uri               => self.uri,
+        :email             => self.email,
+        :name              => self.name,
+        :objectType        => "person",
+
+        :id                => self.uid,
+        :gender            => self.gender,
+        :note              => self.note,
+        :nickname          => self.nickname,
+        :displayName       => self.display_name,
+        :preferredUsername => self.preferred_username,
+        :updated           => self.updated,
+        :published         => self.published,
+        :birthday          => self.birthday,
+        :anniversary       => self.anniversary,
+
+        :pronoun           => self.pronoun,
+
+        :extendedName      => self.extended_name,
+        :organization      => self.organization,
+        :account           => self.account,
+        :address           => self.address
+      }
+    end
+
+    # Creates an Activity where this author acts upon the given object.
+    def act(action, object)
+      type = "person"
+      type = object.type if object.is_a? Nelumba::Activity
+
+      Nelumba::Activity.new :verb   => action,
+                            :actor  => self,
+                            :object => object,
+                            :type   => type
+    end
+
+    # Creates an Activity where this author favorites the given activity.
+    def favorite(activity)
+      self.act(activity, :favorite)
+    end
+
+    # Creates an Activity where this author unfavorites the given activity.
+    def unfavorite(activity)
+      self.act(activity, :unfavorite)
+    end
+
+    # Creates an Activity where this author shares the given activity.
+    def share(activity)
+      self.act(activity, :share)
+    end
+
+    # Creates an Activity where this author unshares the given activity.
+    def unshare(activity)
+      self.act(activity, :unshare)
+    end
+
+    # Creates an Activity where this author follows the given author.
+    def follow(author)
+      self.act(author, :follow)
+    end
+
+    # Creates an Activity where this author stops following the given author.
+    def unfollow(author)
+      self.act(author, :"stop-following")
+    end
+
+    # Determines the displayed name to use to refer to this Person.
+    def preferred_display_name
+      if self.display_name
+        self.display_name
+      elsif self.name
+        self.name
+      elsif self.preferred_username
+        self.preferred_username
+      elsif self.nickname
+        self.nickname
+      else
+        self.uid
+      end
+    end
+
+    # Determines the short name to use to refer to this Person.
+    def preferred_short_name
+      if self.preferred_username
+        self.preferred_username
+      elsif self.nickname
+        self.nickname
+      elsif self.display_name
+        self.display_name
+      elsif self.name
+        self.name
+      else
+        self.uid
+      end
+    end
+
+    # Returns a string containing the JSON representation of this Person.
+    def to_json(*args)
+      to_json_hash.delete_if{|k,v| v.nil?}.to_json(*args)
+    end
+
+    def to_as1(*args)
+      to_json_hash.delete_if{|k,v| v.nil?}.to_json(*args)
+    end
+
+    def to_atom
+      require 'nelumba/atom/person'
+
+      Nelumba::Atom::Person.from_canonical(self).to_xml
+    end
+  end
+end

data/lib/nelumba/place.rb

@@ -0,0 +1,34 @@
+module Nelumba
+  class Place
+    include Nelumba::Object
+
+    attr_reader :position
+    attr_reader :address
+
+    def initialize(options = {}, &blk)
+      init(options, &blk)
+    end
+
+    def init(options = {}, &blk)
+      super(options, &blk)
+
+      @position = options[:position]
+      @address  = options[:address]
+    end
+
+    def to_hash
+      {
+        :position => @position,
+        :address  => @address
+      }.merge(super)
+    end
+
+    def to_json_hash
+      {
+        :objectType => "place",
+        :position   => @position,
+        :address    => @address
+      }.merge(super)
+    end
+  end
+end

data/lib/nelumba/product.rb

@@ -0,0 +1,30 @@
+module Nelumba
+  class Product
+    include Nelumba::Object
+
+    attr_reader :full_image
+
+    def initialize(options = {}, &blk)
+      init(options, &blk)
+    end
+
+    def init(options = {}, &blk)
+      super(options, &blk)
+
+      @full_image = options[:full_image]
+    end
+
+    def to_hash
+      {
+        :full_image => @full_image
+      }.merge(super)
+    end
+
+    def to_json_hash
+      {
+        :objectType => "product",
+        :fullImage  => @full_image
+      }.merge(super)
+    end
+  end
+end

data/lib/nelumba/publisher.rb

@@ -0,0 +1,44 @@
+module Nelumba
+  class Publisher
+    require 'net/http'
+    require 'uri'
+
+    # The url of the feed.
+    attr_reader :url
+
+    # The array of feed urls used to push content. Default: []
+    attr_reader :hubs
+
+    # Creates a representation of a Publisher entity.
+    #
+    # options:
+    #   :feed => A feed to use to populate the other fields.
+    #   :url  => The url of the feed that will be published.
+    #   :hubs => An array of hub urls that are used to handle load
+    #            balancing pushes of new data. Default: []
+    def initialize(options = {}, &blk)
+      init(options, &blk)
+    end
+
+    def init(options = {}, &blk)
+      if options[:feed]
+        @url  = options[:feed].url
+        @hubs = options[:feed].hubs
+      end
+
+      @url  ||= options[:url]
+      @hubs ||= options[:hubs] || []
+    end
+
+    # Will ping PuSH hubs so that they know there is new/updated content. The
+    # hub should respond by pulling the new data and then sending it to
+    # subscribers.
+    def ping_hubs
+      @hubs.each do |hub_url|
+        res = Net::HTTP.post_form(URI.parse(hub_url),
+                                  { 'hub.mode' => 'publish',
+                                    'hub.url' => @topic_url })
+      end
+    end
+  end
+end

data/lib/nelumba/question.rb

@@ -0,0 +1,30 @@
+module Nelumba
+  class Question
+    include Nelumba::Object
+
+    attr_reader :options
+
+    def initialize(options = {}, &blk)
+      init(options, &blk)
+    end
+
+    def init(options = {}, &blk)
+      super(options, &blk)
+
+      @options = options[:options] || []
+    end
+
+    def to_hash
+      {
+        :options => @options.dup
+      }.merge(super)
+    end
+
+    def to_json_hash
+      {
+        :objectType => "question",
+        :options    => @options.dup
+      }.merge(super)
+    end
+  end
+end

data/lib/nelumba/review.rb

@@ -0,0 +1,30 @@
+module Nelumba
+  class Review
+    include Nelumba::Object
+
+    attr_reader :rating
+
+    def initialize(options = {}, &blk)
+      init(options, &blk)
+    end
+
+    def init(options = {}, &blk)
+      super options
+
+      @rating = options[:rating]
+    end
+
+    def to_hash
+      {
+        :rating => @rating
+      }.merge(super)
+    end
+
+    def to_json_hash
+      {
+        :objectType => "review",
+        :rating     => @rating
+      }.merge(super)
+    end
+  end
+end