gnip_gnop 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gnip_gnop.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Kraybill
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# GnipGnop
+
+A ruby library that given a Gnip activity stream XML <entry>, will
+allow you to interact with that entry as a first-class Ruby object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gnip_gnop'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gnip_gnop
+
+## Usage
+
+The library assumes that you have a well formed activity stream
+entry element (generally chunked in via a Gnip stream). You can
+then parse that xml element like this:
+
+    > entry = GnipGnop::Entry.parse(xml)
+
+Given this object reference, you can then "walk" the XML object's
+hierarchy.
+
+    > entry.id
+     => "tag:search.twitter.com,2005:180761363340197888"
+
+Or, a more complex example:
+
+    > entry.author.name
+     => "greeneyedtengu"
+
+Where there were namespace conflicts (for example there is an
+<author> element as well as a namespaced author element, e.g.
+<activity:author>, in which cases I camelcased the accessor.
+
+So for example the activity author has an id, which can be
+accessed like:
+
+    > entry.activity_author.id
+     => "http://twitter.com/greeneyedtengu"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/gnip_gnop.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gnip_gnop/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Kraybill"]
+  gem.email         = ["ckraybill@gmail.com"]
+  gem.description   = %q{A ruby library that given a Gnip activity
+                         stream XML <entry>, will allow you to
+                         interact with that entry as a first-class
+                         Ruby object.}
+  gem.summary       = %q{Work with Gnip activity streams with joy}
+  gem.homepage      = "https://www.github.com/ckraybill/gnip_gnop"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gnip_gnop"
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'happymapper'
+
+  gem.version       = GnipGnop::VERSION
+end

data/lib/gnip_gnop/activity_actor.rb

@@ -0,0 +1,13 @@
+module GnipGnop
+  class ActivityActor
+    include HappyMapper
+
+    tag 'actor'
+
+    namespace 'http://activitystrea.ms/spec/1.0/'
+
+    element :object_type, String, :tag => 'object-type'
+    has_many :links, Link
+    element :id, String, :namespace => 'http://www.w3.org/2005/Atom'
+  end
+end

data/lib/gnip_gnop/activity_author.rb

@@ -0,0 +1,18 @@
+module GnipGnop
+  class ActivityAuthor
+    include HappyMapper
+
+    tag 'author'
+
+    def avatar_image
+      avatar_link = links.detect { |l| l.rel == 'avatar' }
+      avatar_link ? avatar_link.href : ''
+    end
+
+    namespace 'http://activitystrea.ms/spec/1.0/'
+
+    element :object_type, String, :tag => 'object-type'
+    has_many :links, Link
+    element :id, String, :namespace => 'http://www.w3.org/2005/Atom'
+  end
+end

data/lib/gnip_gnop/activity_object.rb

@@ -0,0 +1,14 @@
+module GnipGnop
+  class ActivityObject
+    include HappyMapper
+
+    tag 'object'
+
+    namespace 'http://activitystrea.ms/spec/1.0/'
+
+    element :object_type, String, :tag => 'object-type'
+    element :id, String, :namespace => 'http://www.w3.org/2005/Atom'
+    element :content, String, :attributes => { :type => String }, :namespace => 'http://www.w3.org/2005/Atom'
+    has_one :link, Link
+  end
+end

data/lib/gnip_gnop/author.rb

@@ -0,0 +1,8 @@
+module GnipGnop
+  class Author
+    include HappyMapper
+
+    element :name, String
+    element :uri, String
+  end
+end

data/lib/gnip_gnop/category.rb

@@ -0,0 +1,10 @@
+module GnipGnop
+  class Category
+    include HappyMapper
+
+    tag 'category'
+
+    attribute :term, String
+    attribute :label, String
+  end
+end

data/lib/gnip_gnop/entry.rb

@@ -0,0 +1,25 @@
+module GnipGnop
+  class Entry
+    include HappyMapper
+
+    tag 'entry'
+
+    namespace 'http://www.w3.org/2005/Atom'
+
+    element :id, String
+    element :published, DateTime
+    element :updated, DateTime
+    element :title, String
+    element :summary, String, :attributes => { :type => String }
+    has_many :categories, Category
+    has_one :link, Link
+    has_one :source, Source
+    has_one :service_provider, ServiceProvider
+    element :activity_verb, String, :tag => 'verb', :namespace => 'http://activitystrea.ms/spec/1.0/'
+    has_one :activity_object, ActivityObject
+    has_one :author, Author
+    has_one :activity_author, ActivityAuthor
+    has_one :activity_actor, ActivityActor
+    has_one :matching_rule, MatchingRule
+  end
+end

data/lib/gnip_gnop/link.rb

@@ -0,0 +1,11 @@
+module GnipGnop
+  class Link
+    include HappyMapper
+
+    tag 'link'
+
+    attribute :rel, String
+    attribute :type, String
+    attribute :href, String
+  end
+end

data/lib/gnip_gnop/matching_rule.rb

@@ -0,0 +1,11 @@
+module GnipGnop
+  class MatchingRule
+    include HappyMapper
+
+    tag 'matching_rules'
+
+    namespace 'http://www.gnip.com/schemas/2010'
+
+    element :rule, String, :tag => 'matching_rule'
+  end
+end

data/lib/gnip_gnop/service_provider.rb

@@ -0,0 +1,13 @@
+module GnipGnop
+  class ServiceProvider
+    include HappyMapper
+
+    tag 'provider'
+
+    namespace 'http://activitystrea.ms/service-provider'
+
+    element :name, String, :namespace => 'http://www.w3.org/2005/Atom'
+    element :uri, String, :namespace => 'http://www.w3.org/2005/Atom'
+    element :icon, String, :namespace => 'http://www.w3.org/2005/Atom'
+  end
+end

data/lib/gnip_gnop/source.rb

@@ -0,0 +1,11 @@
+module GnipGnop
+  class Source
+    include HappyMapper
+
+    tag 'source'
+
+    element :title, String
+    element :updated, DateTime
+    has_one :link, Link
+  end
+end

data/lib/gnip_gnop/version.rb

@@ -0,0 +1,3 @@
+module GnipGnop
+  VERSION = "0.0.1"
+end

data/lib/gnip_gnop.rb

@@ -0,0 +1,14 @@
+require 'gnip_gnop/version'
+
+require 'happymapper'
+
+require 'gnip_gnop/link'
+require 'gnip_gnop/category'
+require 'gnip_gnop/author'
+require 'gnip_gnop/source'
+require 'gnip_gnop/service_provider'
+require 'gnip_gnop/activity_object'
+require 'gnip_gnop/activity_author'
+require 'gnip_gnop/activity_actor'
+require 'gnip_gnop/matching_rule'
+require 'gnip_gnop/entry'

data/test/fixtures/entry.xml

@@ -0,0 +1,47 @@
+<entry xmlns:gnip="http://www.gnip.com/schemas/2010" xmlns="http://www.w3.org/2005/Atom">
+  <id>tag:search.twitter.com,2005:180761363340197888</id>
+  <published>2012-03-16T21:04:02Z</published>
+  <updated>2012-03-16T21:04:02Z</updated>
+  <title>greeneyedtengu (Robyn Omega) posted a note on Twitter</title>
+  <summary type="html">@redheadphotog Huh. Good luck hon. You know... Two apartments in our building will be vacant soon... D101 and D103...</summary>
+  <category term="StatusPosted" label="Status Posted"/>
+  <category term="NotePosted" label="Note Posted"/>
+  <link rel="alternate" type="text/html" href="http://twitter.com/greeneyedtengu/statuses/180761363340197888"/>
+  <source>
+    <link rel="self" type="application/atom+xml" href="http://search.twitter.com/search.atom?q=apartments&amp;rpp=99&amp;result_type=recent&amp;since_id=180761625198993408"/>
+    <title>Twitter - Keyword - Notices - apartments</title>
+    <updated>2012-03-16T14-05-25Z</updated>
+  </source>
+  <service:provider xmlns:service="http://activitystrea.ms/service-provider">
+    <name>Twitter</name>
+    <uri>http://www.twitter.com/</uri>
+    <icon/>
+  </service:provider>
+  <activity:verb xmlns:activity="http://activitystrea.ms/spec/1.0/">http://activitystrea.ms/schema/1.0/post</activity:verb>
+  <activity:object xmlns:activity="http://activitystrea.ms/spec/1.0/">
+    <activity:object-type>http://activitystrea.ms
+/schema/1.0/note</activity:object-type>
+    <id>object:tag:search.twitter.com,2005:180761363340197888</id>
+    <content type="html">@&lt;a class=" " href="http://twitter.com/redheadphotog"&gt;redheadphotog&lt;/a&gt; Huh. Good luck hon. You know... Two &lt;em&gt;apartments&lt;/em&gt; in our building will be vacant soon... D101 and D103...</content>
+    <link rel="alternate" type="text/html" href="http://twitter.com/greeneyedtengu/statuses/180761363340197888"/>
+  </activity:object>
+  <author>
+    <name>greeneyedtengu</name>
+    <uri>http://twitter.com/greeneyedtengu</uri>
+  </author>
+  <activity:author xmlns:activity="http://activitystrea.ms/spec/1.0/">
+    <activity:object-type>http://activitystrea.ms/schema/1.0/person</activity:object-type>
+    <link rel="alternate" type="text/html" length="0" href="http://twitter.com/greeneyedtengu"/>
+    <link rel="avatar" type="image/png" href="http://a0.twimg.com/profile_images/1886588117/profile_normal.jpg"/>
+    <id>http://twitter.com/greeneyedtengu</id>
+  </activity:author>
+  <activity:actor xmlns:activity="http://activitystrea.ms/spec/1.0/">
+    <activity:object-type>http://activitystrea.ms/schema/1.0/person</activity:object-type>
+    <link rel="alternate" type="text/html" length="0" href="http://twitter.com/greeneyedtengu"/>
+    <link rel="avatar" type="image/png" href="http://a0.twimg.com/profile_images/1886588117/profile_normal.jpg"/>
+    <id>http://twitter.com/greeneyedtengu</id>
+  </activity:actor>
+  <gnip:matching_rules>
+    <gnip:matching_rule rel="source">apartments</gnip:matching_rule>
+  </gnip:matching_rules>
+</entry>

data/test/gnip_gnop_entry_test.rb

@@ -0,0 +1,92 @@
+require 'minitest_helper'
+
+describe GnipGnop::Entry do
+
+  def xml
+    @xml ||= File.read(File.expand_path('../fixtures/entry.xml', __FILE__))
+  end
+
+  before do
+    @entry = GnipGnop::Entry.parse(xml)
+  end
+
+  it "should parse a top-level element" do
+    @entry.id.must_equal "tag:search.twitter.com,2005:180761363340197888"
+  end
+
+  it "should parse the summary's text" do
+    @entry.summary.must_equal "@redheadphotog Huh. Good luck hon. You know... Two apartments in our building will be vacant soon... D101 and D103..."
+  end
+
+  it "should parse the summary's type attribute" do
+    @entry.summary.type.must_equal 'html'
+  end
+
+  it "should parse the entry's link's href" do
+    @entry.link.href.must_equal "http://twitter.com/greeneyedtengu/statuses/180761363340197888"
+  end
+
+  it "should parse the entry's source's link's href" do
+    @entry.source.link.href.must_equal "http://search.twitter.com/search.atom?q=apartments&rpp=99&result_type=recent&since_id=180761625198993408"
+  end
+
+  it "should parse the entry's source's title" do
+    @entry.source.title.must_equal "Twitter - Keyword - Notices - apartments"
+  end
+
+  it "should parse the entry's provider" do
+    @entry.service_provider.name.must_equal "Twitter"
+  end
+
+  it "should parse the entry's verb" do
+    @entry.activity_verb.must_equal "http://activitystrea.ms/schema/1.0/post"
+  end
+
+  it "should parse the entry's object's link's href" do
+    @entry.activity_object.link.href.must_equal "http://twitter.com/greeneyedtengu/statuses/180761363340197888"
+  end
+
+  it "should parse the entry's object's id" do
+    @entry.activity_object.id.must_equal "object:tag:search.twitter.com,2005:180761363340197888"
+  end
+
+  it "should parse the author's name" do
+    @entry.author.name.must_equal "greeneyedtengu"
+  end
+
+  it "should parse the namespaced author's namespaced object-type" do
+    @entry.activity_author.object_type.must_equal "http://activitystrea.ms/schema/1.0/person"
+  end
+
+  it "should parse the namespaced author's differently namespaced id" do
+    @entry.activity_author.id.must_equal "http://twitter.com/greeneyedtengu"
+  end
+
+  it "should parse the namespaced author's avatar image" do
+    @entry.activity_author.avatar_image.must_equal "http://a0.twimg.com/profile_images/1886588117/profile_normal.jpg"
+  end
+
+  it "should parse the namespaced author's links into an arrary" do
+    @entry.activity_author.links.must_be_kind_of Array
+  end
+
+  it "should parse all of the namespaced author's links" do
+    @entry.activity_author.links.size.must_equal 2
+  end
+
+  it "should parse the namespaced actor's differently namespaced id" do
+    @entry.activity_actor.id.must_equal "http://twitter.com/greeneyedtengu"
+  end
+
+  it "should parse the namespaced actor's links into an arrary" do
+    @entry.activity_actor.links.must_be_kind_of Array
+  end
+
+  it "should parse all of the namespaced actor's links" do
+    @entry.activity_actor.links.size.must_equal 2
+  end
+
+  it "should parse the matching rules" do
+    @entry.matching_rule.rule.must_equal "apartments"
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+
+require 'gnip_gnop'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: gnip_gnop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Kraybill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: happymapper
+  requirement: &70126788536440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70126788536440
+description: ! "A ruby library that given a Gnip activity\n                         stream
+  XML <entry>, will allow you to\n                         interact with that entry
+  as a first-class\n                         Ruby object."
+email:
+- ckraybill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- gnip_gnop.gemspec
+- lib/gnip_gnop.rb
+- lib/gnip_gnop/activity_actor.rb
+- lib/gnip_gnop/activity_author.rb
+- lib/gnip_gnop/activity_object.rb
+- lib/gnip_gnop/author.rb
+- lib/gnip_gnop/category.rb
+- lib/gnip_gnop/entry.rb
+- lib/gnip_gnop/link.rb
+- lib/gnip_gnop/matching_rule.rb
+- lib/gnip_gnop/service_provider.rb
+- lib/gnip_gnop/source.rb
+- lib/gnip_gnop/version.rb
+- test/fixtures/entry.xml
+- test/gnip_gnop_entry_test.rb
+- test/minitest_helper.rb
+homepage: https://www.github.com/ckraybill/gnip_gnop
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Work with Gnip activity streams with joy
+test_files:
+- test/fixtures/entry.xml
+- test/gnip_gnop_entry_test.rb
+- test/minitest_helper.rb