onebox 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88403edb6cdc6198f956ebbbfa444ab6855098df
-  data.tar.gz: 0dbd27e20e524df654834fdfac709b3590cad2d2
+  metadata.gz: 292535107d74004655646908fd33b6a4aba4229c
+  data.tar.gz: 7b2da58a31b11b745b7f0e4cffa96c050f190637
 SHA512:
-  metadata.gz: d5f8f6bcc6892fc0e6dff02e6264db3f8be631004353cf63ca2a6dbc0b07f07843549a4180a895a64c98b8a87be451e23b1520306485e3c5a73fd3b9d2b6acfb
-  data.tar.gz: 56927cce2f14d3b7149352f78ebfe3f8e91131fc1c17896f78855bf97924022b38ae373ef1ef2cb26855409c9b215a824b1943c198b71b72689323b778bb77a5
+  metadata.gz: 544481fff1bba95af38f1467c35b509d5aa8f6a725f6912ab7f63d31055f2d0073ffce2962b3d546eb06834ddc2d81bcb01eb108d963661c4987e2729b590a23
+  data.tar.gz: 8b7970957af9cd698f52e242d6092acbaca945dd8fbe3f45617d471562c787b8c00b7223846342ca5cd08f4801b097e4fee9892b9d6ae8973ced5c4e34f7d67f

data/README.md

@@ -47,14 +47,9 @@ Onebox currently has support for page, image, and video URLs from these sites:
 Using onebox
 ===============
 
-You can include onebox modules into a class like so:
-
 ``` ruby
 require "onebox"
 ```
-TODO: write example
-
-
 
 The `Gemfile` file would look like this:
 
@@ -62,7 +57,94 @@ The `Gemfile` file would look like this:
 # source/Gemfile
 source "https://rubygems.org"
 
-gem "onebox", "~> <%= version %>"
+gem "onebox", "~> 1.0"
+```
+
+How to create a new onebox
+===========================
+
+1. Create new onebox engine
+
+``` ruby
+# in lib/onebox/engine/name_onebox.rb
+
+module Onebox
+  module Engine
+    class NameOnebox
+      include Engine
+
+      private
+
+      def extracted_data
+        {
+          url: @url,
+          name: @body.css("h1").inner_text,
+          image: @body.css("#main-image").first["src"],
+          description: @body.css("#postBodyPS").inner_text
+        }
+      end
+    end
+  end
+end
+```
+
+2. Create new onebox spec
+
+``` ruby
+# in spec/lib/onebox/engine/name_spec.rb
+require "spec_helper"
+
+describe Onebox::Engine::NameOnebox do
+  let(:link) { "http://yoursitename.com" }
+  let(:html) { described_class.new(link).to_html }
+
+  before do
+    fake(link, response("name.response"))
+  end
+
+  it "returns video title" do
+    expect(html).to include("title")
+  end
+
+  it "returns video photo" do
+    expect(html).to include("photo.jpg")
+  end
+
+  it "returns video description" do
+    expect(html).to include("description")
+  end
+
+  it "returns URL" do
+    expect(html).to include(link)
+  end
+end
+```
+
+3. Create new handlebars template
+
+``` html
+# in templates/name.handlebars
+<div class="onebox">
+  <a href="{{url}}">
+    <h1>{{name}}</h1>
+    <h2 class="host">yoursitename.com</h2>
+    <img src="{{image}}" />
+    <p>{{description}}</p>
+  </a>
+</div>
+```
+
+4. Create new fixture from HTML response
+
+``` bash
+curl --output spec/fixtures/name.response -L -X -GET http://yoursitename.com
+```
+
+5. Require in Engine module
+
+``` ruby
+# in lib/onebox/engine/engine.rb
+require_relative "engine/name_onebox"
 ```
 
 

data/lib/onebox/engine.rb

@@ -38,7 +38,16 @@ module Onebox
     end
 
     def template
-      File.read(File.join("templates", "#{template_name}.handlebars"))
+      File.read(template_path)
+    end
+
+    def template_path
+      File.join(root, "templates", "#{template_name}.handlebars")
+    end
+
+    # returns the gem root directory
+    def root
+      Gem::Specification.find_by_name("onebox").gem_dir
     end
 
     # calculates handlebars template name for onebox using name of engine

data/lib/onebox/version.rb

@@ -1,3 +1,3 @@
 module Onebox
-  VERSION = "1.0.0"
-end
+  VERSION = "1.0.1"
+end

data/spec/lib/onebox/engine_spec.rb

@@ -51,6 +51,16 @@ describe Onebox::Engine do
     end
   end
 
+  describe "#template_path" do
+    it "returns file path for onebox template" do
+      class OneboxEngineVoo
+        include Onebox::Engine
+      end
+      result = OneboxEngineVoo.new("http://amazon.com").send(:template_path)
+      expect(result).to eq("/home/jzeta/Projects/rgsoc/onebox/templates/enginevoo.handlebars")
+    end
+  end
+
   describe ".===" do
     it "returns true if argument matches the matcher" do
       class OneboxEngineFoo

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onebox
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Joanna Zeta