sg_node_mapper 0.0.1 → 0.1.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/README.md

@@ -1,5 +1,7 @@
 # SgNodeMapper
 
+[![Build Status](https://secure.travis-ci.org/hecticjeff/sg_node_mapper.png?branch=master)](http://travis-ci.org/hecticjeff/sg_node_mapper)
+
 Lightweight ruby wrapper around the Social Graph Node Mapper [javascript
 library](https://github.com/webjay/sgNodeMapper).
 

data/Rakefile

@@ -1,2 +1,9 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/sg_node_mapper.rb

@@ -7,6 +7,7 @@ require 'active_support/core_ext'
 
 # Internal
 require 'sg_node_mapper/version'
+require 'sg_node_mapper/caching'
 
 # Simple wrapper for the sgNodeMapper javascript library. Uses
 # [ExecJS](https://github.com/sstephenson/execjs) to dynamically select the best
@@ -18,6 +19,9 @@ require 'sg_node_mapper/version'
 # delegating to javascript.
 class SgNodeMapper
   include Singleton
+  include Caching
+
+  class Error < StandardError; end
 
   # When a method is called on this class, we intercept it and pass it through
   # to the javascript context by converting the method name from underscore_case
@@ -29,9 +33,17 @@ class SgNodeMapper
   #
   # Returns the result from javascript.
   def self.method_missing(method, *args)
-    instance.context.call("nodemapper.#{method.to_s.camelize(:lower)}", *args)
+    instance.send(method, *args)
+  end
+
+  def method_missing(method, *args)
+    cache_and_return method, *args do
+      context.call("nodemapper.#{method.to_s.camelize(:lower)}", *args)
+    end
   end
 
+  private
+
   # Get a (potentially cached) version of the compiled source code for sgNodeMapper.
   #
   # Returns an ExecJS::ExternalRuntime::Context.
@@ -39,13 +51,12 @@ class SgNodeMapper
     @context ||= ExecJS.compile(source)
   end
 
-  private
 
-  # Get a (potentially cached) string of the sgNodeMapper source code.
+  # Get a string of the sgNodeMapper source code.
   #
   # Returns the String javascript source code.
   def source
-    @source ||= File.read(source_path)
+    File.read(source_path)
   end
 
   # Get the full path to the sgNodeMapper.js source code.

data/lib/sg_node_mapper/caching.rb

@@ -0,0 +1,15 @@
+class SgNodeMapper
+  module Caching
+
+    private
+
+    def cache_and_return(method, *args)
+      raise Error, 'You must call cache_and_return with a block' unless block_given?
+      cache[method][args] ||= yield
+    end
+
+    def cache
+      @cache ||= Hash.new { |h, k| h[k] = {} }
+    end
+  end
+end

data/lib/sg_node_mapper/version.rb

@@ -1,3 +1,3 @@
 class SgNodeMapper
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/sg_node_mapper.gemspec

@@ -17,4 +17,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'execjs', '>= 1.4'
   gem.add_dependency 'activesupport', '>= 3.0'
+
+  gem.add_development_dependency 'rake', '>= 0.9'
+  gem.add_development_dependency 'rspec', '>= 2.10'
 end

data/spec/sg_node_mapper/caching_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe SgNodeMapper::Caching do
+  let(:js_context) { double }
+  before { SgNodeMapper.instance.stub(context: js_context) }
+
+  describe "cache miss" do
+
+    it "calls the javascript context" do
+      js_context.should_receive(:call).with('nodemapper.urlToGraphNode', 'miss').and_return('fresh')
+      SgNodeMapper.url_to_graph_node('miss')
+    end
+  end
+
+  describe "cache hit" do
+    before do
+      js_context.stub(call: 'cached')
+
+      # Prime the cache.
+      SgNodeMapper.url_to_graph_node('hit')
+    end
+
+    it "doesn't call the javascript context" do
+      js_context.should_not_receive(:call)
+      SgNodeMapper.url_to_graph_node('hit').should == 'cached'
+    end
+  end
+end

data/spec/sg_node_mapper_spec.rb

@@ -5,4 +5,20 @@ describe SgNodeMapper do
     subject { SgNodeMapper.url_to_graph_node('http://twitter.com/google') }
     it { should == 'sgn://twitter.com/?ident=google' }
   end
+
+  describe ".parse_sgn_url('sgn://twitter.com/?ident=google')" do
+    subject { SgNodeMapper.parse_sgn_url('sgn://twitter.com/?ident=google') }
+
+    it "returns a hash" do
+      subject.should be_a_kind_of(Hash)
+      subject['domain'].should == 'twitter.com'
+      subject['keyName'].should == 'ident'
+      subject['value'].should == 'google'
+    end
+  end
+
+  describe ".url_from_graph_node('sgn://twitter.com/?ident=google', 'profile')" do
+    subject { SgNodeMapper.url_from_graph_node('sgn://twitter.com/?ident=google', 'profile') }
+    it { should == 'http://twitter.com/google' }
+  end
 end

metadata

@@ -1,48 +1,80 @@
 --- !ruby/object:Gem::Specification
 name: sg_node_mapper
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.0.1
+  version: 0.1.0
+  prerelease: 
 platform: ruby
 authors:
 - Chris Mytton
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-13 00:00:00.000000000 Z
+date: 2012-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.4'
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: activesupport
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
   prerelease: false
-  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.10'
 description: Map social networking sites' URLs to and from a canonical form.
 email:
 - self@hecticjeff.net
@@ -50,60 +82,49 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- !binary |-
-  LmdpdGlnbm9yZQ==
-- !binary |-
-  LnJzcGVj
-- !binary |-
-  R2VtZmlsZQ==
-- !binary |-
-  TElDRU5TRQ==
-- !binary |-
-  UkVBRE1FLm1k
-- !binary |-
-  UmFrZWZpbGU=
-- !binary |-
-  bGliL3NnX25vZGVfbWFwcGVyLnJi
-- !binary |-
-  bGliL3NnX25vZGVfbWFwcGVyL3ZlcnNpb24ucmI=
-- !binary |-
-  c2dfbm9kZV9tYXBwZXIuZ2Vtc3BlYw==
-- !binary |-
-  c3BlYy9zZ19ub2RlX21hcHBlcl9zcGVjLnJi
-- !binary |-
-  c3BlYy9zcGVjX2hlbHBlci5yYg==
-- !binary |-
-  dmVuZG9yL3NnX25vZGVfbWFwcGVyL0xJQ0VOU0U=
-- !binary |-
-  dmVuZG9yL3NnX25vZGVfbWFwcGVyL25vZGVtYXBwZXIuanM=
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sg_node_mapper.rb
+- lib/sg_node_mapper/caching.rb
+- lib/sg_node_mapper/version.rb
+- sg_node_mapper.gemspec
+- spec/sg_node_mapper/caching_spec.rb
+- spec/sg_node_mapper_spec.rb
+- spec/spec_helper.rb
+- vendor/sg_node_mapper/LICENSE
+- vendor/sg_node_mapper/nodemapper.js
 homepage: https://github.com/hecticjeff/sg_node_mapper
 licenses: []
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
 specification_version: 3
-summary: The Social Graph Node Mapper is a community project to build a portable library to map social networking sites' URLs to and from a canonical form (sgn:// URLs).
+summary: The Social Graph Node Mapper is a community project to build a portable library
+  to map social networking sites' URLs to and from a canonical form (sgn:// URLs).
 test_files:
-- !binary |-
-  c3BlYy9zZ19ub2RlX21hcHBlcl9zcGVjLnJi
-- !binary |-
-  c3BlYy9zcGVjX2hlbHBlci5yYg==
+- spec/sg_node_mapper/caching_spec.rb
+- spec/sg_node_mapper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: