meta_hari 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bff4312d86ff4bee5be187b150ef238f404369f5
+  data.tar.gz: 06b08dbea9f2720e174f67914a208d3c7ae7ede2
+SHA512:
+  metadata.gz: 735398073cd3179c1cb9e7319fcf4cc050448ca9d187b7834eb4115f8a2f8dafc5d97ea0ec580d7feec967a35aaa38db8503a677a264cb8392291998133c8a52
+  data.tar.gz: 919c189e56767d3ec3f469a9e8083e65d0601634eda0e0c189e0f3a51726f2deaa9921e62268cd9f94dded4db89daf8c554352431c0443a0cbf725ff26ff45b1

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Exclude:
+    - 'meta_hari.gemspec'
+    - 'Guardfile'
+
+Style/Documentation:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: true

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,135 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Paul Spieker
+
+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,86 @@
+# MetaHari
+
+Meta Hari is receiving product informations from a given product link
+(i.e. from Amazon).
+
+The name Meta Hari comes from
+[Mata Hari](https://en.wikipedia.org/wiki/Mata_Hari), one of the most
+popular spies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'meta_hari'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install meta_hari
+
+## Usage
+
+In order to receive product informations, just pass the URL containing
+thous informations to the method `MetaHari.spy`.
+
+```ruby
+product = MetaHari.spy('http://www.amazon.de/Gastroback-42429-Design-Wasserkocher-Advanced/dp/B000LQXC2Q/ref=sr_1_1')
+product.inspect # => #<OpenStruct name="Gastroback 42429 Design Wasserkocher Advanced Pro", image="http://ecx.images-amazon.com/images/I/814Yl6mxLsL._SL1500_.jpg", description="">
+```
+
+## Implemented spyglasses
+
+A spyglass is a support class for a specific shop. In order to support
+custom shops which can not be spyed by the generic spyglass
+(`MetaHari::Spyglass::Base`), a new spyglass has to be created.
+
+* Amazon DE
+* Generic
+  * Shops using [JSON-LD](https://developers.google.com/structured-data/rich-snippets/products)
+
+### Creating a spyglass
+
+A spyglass has to be a class within the namespace `MetaHari::Spyglass`
+and must extend the class `MetaHari::Spyglass::Base`. The methods
+`self.suitable?` and `spy`.
+
+```ruby
+module MetaHari
+  module Spyglass
+    class AmazonDe < Base
+      def self.suitable?(uri)
+        %w(amazon.de www.amazon.de).include? uri.host.downcase
+      end
+
+      def spy
+        OpenStruct.new(name: title, image: image, description: '')
+      end
+
+      protected
+
+      def title
+        document.css('#productTitle').text
+      end
+
+      def image
+        data = document.css('img#landingImage')
+        data &&= data.attr 'data-old-hires'
+        data && data.value
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/spieker/meta_hari/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test:    :spec
+
+desc 'Open an irb session preloaded with this library'
+task :console do
+  sh 'irb -rubygems -I lib -r meta_hari.rb'
+end

data/lib/meta_hari/helpers/json_ld.rb

@@ -0,0 +1,29 @@
+module MetaHari
+  module Helpers
+    class JsonLd
+      attr_reader :document
+
+      def initialize(document)
+        @document = document
+      end
+
+      def data(type = 'Product')
+        (json['@type'] == type) ? json : {}
+      end
+
+      protected
+
+      def selector
+        'script[type="application/ld+json"]'
+      end
+
+      def json
+        @json ||= begin
+                    script = document.css(selector).first
+                    return {} unless script
+                    JSON.parse! script
+                  end
+      end
+    end
+  end
+end

data/lib/meta_hari/helpers.rb

@@ -0,0 +1,6 @@
+require 'meta_hari/helpers/json_ld'
+
+module MetaHari
+  module Helpers
+  end
+end

data/lib/meta_hari/spyglass/amazon_de.rb

@@ -0,0 +1,25 @@
+module MetaHari
+  module Spyglass
+    class AmazonDe < Base
+      def self.suitable?(uri)
+        %w(amazon.de www.amazon.de).include? uri.host.downcase
+      end
+
+      def spy
+        OpenStruct.new(name: title, image: image, description: '')
+      end
+
+      protected
+
+      def title
+        document.css('#productTitle').text
+      end
+
+      def image
+        data = document.css('img#landingImage')
+        data &&= data.attr 'data-old-hires'
+        data && data.value
+      end
+    end
+  end
+end

data/lib/meta_hari/spyglass/base.rb

@@ -0,0 +1,63 @@
+require 'ostruct'
+
+module MetaHari
+  module Spyglass
+    class Base
+      attr_reader :uri
+
+      def self.suitable?(uri)
+        fail StandardError.new, "not implemented for '#{uri.host}'"
+      end
+
+      def initialize(uri)
+        @uri = uri
+      end
+
+      def spy
+        OpenStruct.new [
+          spy_json_ld
+        ].inject({}) { |a, e| a.merge e }
+      end
+
+      protected
+
+      def user_agent
+        [
+          'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_5)',
+          'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/36.0.1985.125',
+          'Safari/537.36'
+        ].join(' ')
+      end
+
+      def fetch_request
+        path = uri.path.empty? ? '/' : uri.path
+        Net::HTTP::Get.new path, 'User-Agent' => user_agent
+      end
+
+      def fetch_response
+        Net::HTTP.start uri.host, uri.port do |http|
+          http.request fetch_request
+        end
+      end
+
+      def fetch_data(limit = 10)
+        return @_data if @_data
+        fail ArgumentError.new, 'HTTP redirect too deep' if limit == 0
+        case res = fetch_response
+        when Net::HTTPSuccess     then @_data = res.body
+        when Net::HTTPRedirection then fetch_data res['location'], limit - 1
+        else res.error!
+        end
+      end
+
+      def document
+        @document ||= Nokogiri::HTML fetch_data
+      end
+
+      def spy_json_ld
+        json_ld = MetaHari::Helpers::JsonLd.new(document)
+        json_ld.data
+      end
+    end
+  end
+end

data/lib/meta_hari/spyglass.rb

@@ -0,0 +1,7 @@
+require 'meta_hari/spyglass/base'
+require 'meta_hari/spyglass/amazon_de'
+
+module MetaHari
+  module Spyglass
+  end
+end

data/lib/meta_hari/version.rb

@@ -0,0 +1,4 @@
+# MetaHari version
+module MetaHari
+  VERSION = '0.0.1'
+end

data/lib/meta_hari.rb

@@ -0,0 +1,45 @@
+require 'nokogiri'
+require 'json'
+require 'uri'
+require 'net/http'
+require 'meta_hari/version'
+require 'meta_hari/helpers'
+require 'meta_hari/spyglass'
+
+# MetaHary will find product informations for a given product link. The
+# information will be wrapped into an OpenStruct.
+#
+# Example
+# =======
+#
+# ```ruby
+# product = MetaHari.spy('http://example.com/product.html')
+# ```
+module MetaHari
+  class <<self
+    def spy(url)
+      uri = URI.parse url
+      spyglass = suitable_spyglass_instance uri
+      spyglass.spy
+    end
+
+    private
+
+    def suitable_spyglass_instance(uri)
+      klass = find_suitable_spyglass(uri)
+      klass.new(uri)
+    end
+
+    # Finding a suitable spyglass for the given URL. If no suitable spyglass
+    # is found, the default spyglass (MetaHari::Spyglass::Base) is returned.
+    #
+    def find_suitable_spyglass(uri)
+      spyglasses = MetaHari::Spyglass.constants.map do |c|
+        MetaHari::Spyglass.const_get(c)
+      end
+      spyglasses.select! { |spyglass| spyglass < MetaHari::Spyglass::Base }
+      suitable_spyglass = spyglasses.find { |spyglass| spyglass.suitable? uri }
+      suitable_spyglass || MetaHari::Spyglass::Base
+    end
+  end
+end

data/meta_hari.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'meta_hari/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'meta_hari'
+  spec.version       = MetaHari::VERSION
+  spec.authors       = ['Paul Spieker']
+  spec.email         = ['p.spieker@duenos.de']
+  spec.summary       = %q{Receiving product informations from a given link.}
+  spec.homepage      = 'https://github.com/spieker/meta_hari'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.2.0'
+  spec.add_development_dependency 'guard', '~> 2.12.5'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.31.0'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2.0'
+  spec.add_development_dependency 'pry', '~> 0.10.1'
+  spec.add_development_dependency 'nokogiri', '~> 1.6.6'
+end

data/spec/lib/meta_hari/helpers/json_ld_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe MetaHari::Helpers::JsonLd do
+  let(:html)     { resource_content('json_ld_example.html') }
+  let(:document) { Nokogiri::HTML html }
+  subject        { described_class.new document }
+
+  describe '#initialize' do
+    it 'assigns the document to the reader' do
+      expect(subject.document).to be document
+    end
+  end
+
+  context 'when containing JSON-LD' do
+    describe '#json' do
+      subject { described_class.new(document).send :json }
+
+      it { should be_a Hash }
+      it { should have_key '@context' }
+      it { should have_key '@type' }
+      it { should have_key 'name' }
+      it { should have_key 'image' }
+      it { should have_key 'description' }
+
+      it 'is a product' do
+        expect(subject['@type']).to eql 'Product'
+      end
+    end
+
+    describe '#data' do
+      it 'uses #json' do
+        expect(subject).to receive(:json).and_return({})
+        subject.data
+      end
+
+      context 'when type matches' do
+        subject { described_class.new(document).data }
+
+        it { should be_a Hash }
+        it { should have_key '@context' }
+        it { should have_key '@type' }
+        it { should have_key 'name' }
+        it { should have_key 'image' }
+        it { should have_key 'description' }
+      end
+
+      context 'when type does not match' do
+        subject { described_class.new(document).data('Something else') }
+
+        it { should be_a Hash }
+        it { should_not have_key '@context' }
+        it { should_not have_key '@type' }
+        it { should_not have_key 'name' }
+        it { should_not have_key 'image' }
+        it { should_not have_key 'description' }
+      end
+    end
+  end
+
+  context 'when not containing JSON-LD' do
+    let(:html) { '' }
+
+    describe '#json' do
+      subject { described_class.new(document).send :json }
+
+      it { should be_a Hash }
+      it { should_not have_key '@context' }
+      it { should_not have_key '@type' }
+      it { should_not have_key 'name' }
+      it { should_not have_key 'image' }
+      it { should_not have_key 'description' }
+    end
+  end
+end

data/spec/lib/meta_hari/spyglass/amazon_de_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe MetaHari::Spyglass::AmazonDe do
+  let(:uri)      { URI.parse 'http://www.amazon.de/dp/B000LQXC2Q/ref=sr_1_1' }
+  let(:html)     { '' }
+  let(:instance) { described_class.new uri }
+  subject        { instance }
+
+  before :each do
+    allow(instance).to receive(:fetch_data).and_return(html)
+  end
+
+  it 'is suitable for amazon.de' do
+    uri = URI.parse 'http://amazon.de'
+    expect(described_class.suitable? uri).to be true
+  end
+
+  it 'is suitable for www.amazon.de' do
+    uri = URI.parse 'http://www.amazon.de'
+    expect(described_class.suitable? uri).to be true
+  end
+
+  context 'with valid amazn product page' do
+    let(:html) { resource_content 'amazon_de.html' }
+
+    it 'extracts the correct title' do
+      expected_value = 'Gastroback 42429 Design Wasserkocher Advanced Pro'
+      expect(subject.send :title).to eql expected_value
+    end
+
+    it 'extracts the correct image' do
+      expected_value =
+        'http://ecx.images-amazon.com/images/I/814Yl6mxLsL._SL1500_.jpg'
+      expect(subject.send :image).to eql expected_value
+    end
+  end
+
+  describe '#spy' do
+    let(:html) { resource_content 'amazon_de.html' }
+    subject    { instance.spy }
+
+    it { should be_an OpenStruct }
+    it { should respond_to :name }
+    it { should respond_to :image }
+    it { should respond_to :description }
+  end
+end