kabutops 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddd72a59b7d2055cb55e305f2f365bc2fcbf8b23
+  data.tar.gz: b065d94ff1311e7051e9ba5a88dd5b8079923a75
+SHA512:
+  metadata.gz: 406b830a7b6f936a805c4403e98abfdfd71ee72fffc73f46ae2ac0cb985a1fe0502111767a761cfa319a16cb86986802f0bc11c70847bac99fa5b678fb051d9d
+  data.tar.gz: 3230fd659aa8241ce9dcc6eb174bdb51d1e2b35d9d7bdcac47f33ff304ff14846b166439ecb9d8abdd27294eccaf3e865afc4e47edd3a0c81e9a3615671d23a4

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,87 @@
+Kabutops
+========
+
+Installation
+------------
+
+You can install it via gem
+
+```bash
+gem install kabutops
+```
+
+Or you can put it in your Gemfile
+
+```ruby
+gem 'kabutops'
+```
+
+Basic example
+-------------
+
+Create **fruit_crawler.rb**.
+
+```ruby
+require 'kabutops'
+
+class FruitCrawler < Kabutops::Crawler
+  include Sidekiq::Worker
+
+  collection (1..5).map { |id|
+               {
+                 id: id,
+                 url: "https://www.example.com/fruits/#{id}",
+               }
+             }.shuffle
+  proxy '127.0.0.1', 81818
+  cache true
+
+  elasticsearch do
+    index :books
+    document :book
+
+    data do
+      id :var, :id
+      url :var, :url
+      some_attr :css, 'h1.bookTitle'
+      grape :lambda, ->(page) {
+        page.css('h3.fruit').split(',').first 
+      }
+
+      nested_attr do
+        apple :css, 'h1.bookTitle'
+        banana :xpath, '//table/tr/td[0]'
+      end
+    end
+  end
+
+  callback do |resource, page|
+  end
+end
+
+FruitCrawler.crawl!
+```
+
+Run it via sidekiq
+
+```bash
+bundle exec sidekiq -r ./fruit_crawler.rb -c 10
+```
+
+This example will parallely crawl specified urls and result will be
+stored to the ElasticSearch index named books as a book document.
+
+One document will look something like this
+
+```json
+{
+  'id': '...',
+  'url': '...',
+  'some_attr': '...',
+  'grape': '...',
+  'nested_attr': {
+    'apple': '...',
+    'banana': '...'
+  }
+}
+```

data/lib/kabutops.rb

@@ -0,0 +1,18 @@
+require 'sidekiq'
+require 'cachy'
+require 'moneta'
+require 'pstore'
+
+Cachy.cache_store = Moneta.new(:File, dir: 'cache') # temporary
+
+require 'kabutops/recipe'
+require 'kabutops/recipe_item'
+require 'kabutops/adapters/callback'
+require 'kabutops/adapters/database_adapter'
+require 'kabutops/adapters/elastic_search'
+require 'kabutops/adapters/mysql'
+require 'kabutops/crawler_extensions/callback'
+require 'kabutops/crawler_extensions/elastic_search'
+require 'kabutops/crawler_extensions/mysql'
+require 'kabutops/crawler_extensions/pstore_storage'
+require 'kabutops/crawler'

data/lib/kabutops/adapters/callback.rb

@@ -0,0 +1,15 @@
+module Kabutops
+  module Adapters
+    class Callback
+      attr_accessor :block
+
+      def initialize block
+        @block = block
+      end
+
+      def process resource, page
+        block.call(resource, page)
+      end
+    end
+  end
+end

data/lib/kabutops/adapters/database_adapter.rb

@@ -0,0 +1,23 @@
+module Kabutops
+  module Adapters
+    class DatabaseAdapter
+      def data &block
+        @recipe = Recipe.new
+        @recipe.instance_eval &block
+      end
+
+      def process resource, page
+        result = @recipe.process(resource, page)
+        store(result)
+      end
+
+      def store result
+        raise NotImplementedError
+      end
+
+      def nested?
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/kabutops/adapters/elastic_search.rb

@@ -0,0 +1,23 @@
+module Kabutops
+  module Adapters
+    class ElasticSearch < DatabaseAdapter
+      def index value
+        @index = value
+      end
+
+      def document value
+        @document = value
+      end
+
+      def store result
+        p result
+        p result
+        p result
+      end
+
+      def nested?
+        true
+      end
+    end
+  end
+end

data/lib/kabutops/adapters/mysql.rb

@@ -0,0 +1,13 @@
+module Kabutops
+  module Adapters
+    class MySQL < DatabaseAdapter
+      def table value
+        @table = value
+      end
+
+      def nested?
+        false
+      end
+    end
+  end
+end

data/lib/kabutops/crawler.rb

@@ -0,0 +1,70 @@
+module Kabutops
+  class Crawler
+    include CrawlerExtensions::ElasticSearch
+    include CrawlerExtensions::Callback
+
+    class << self
+      include CrawlerExtensions::PStoreStorage
+
+      attr_reader :params
+
+      [
+        :collection,
+        :workers,
+        :proxy,
+        :cache
+      ].each do |name|
+        define_method name do |*args|
+          @params ||= {}
+          if args.size == 1
+            @params[name] = args[0]
+          else
+            @params[name] = args
+          end
+        end
+      end
+
+      def params
+        @params
+      end
+
+      def adapters
+        @adapters
+      end
+
+      def crawl! collection=nil
+        if storage(:status) == :none
+          @collection = collection || @params[:collection] || []
+          @collection.each do |resource|
+            raise "url must be specified" if resource[:id].nil?
+            perform_async(resource)
+          end
+        end
+      end
+
+      def << resource
+        perform_async(resource)
+      end
+    end
+
+    def perform resource
+      resource = resource.inject({}) { |h, (k, v)| h[k.to_sym] = v; h }
+
+      content = Cachy.cache_if(self.class.params[:cache], resource[:url]) do
+        agent = Mechanize.new
+        #agent.set_proxy(*self.class.params[:proxy])
+        agent.get(resource[:url]).body
+      end
+
+      page = Nokogiri::HTML(content)
+
+      self.class.adapters.each do |adapter|
+        adapter.process(resource, page)
+      end
+    end
+
+    def << resource
+      self.class.perform_async(resource)
+    end
+  end
+end

data/lib/kabutops/crawler_extensions/callback.rb

@@ -0,0 +1,24 @@
+module Kabutops
+
+  module CrawlerExtensions
+
+    module Callback
+
+      def self.included base
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def callback &block
+          adapter = Adapters::Callback.new(block)
+
+          @adapters ||= []
+          @adapters << adapter
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/kabutops/crawler_extensions/elastic_search.rb

@@ -0,0 +1,24 @@
+module Kabutops
+
+  module CrawlerExtensions
+
+    module ElasticSearch
+      def self.included base
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def elasticsearch &block
+          adapter = Adapters::ElasticSearch.new
+          adapter.instance_eval &block
+
+          @adapters ||= []
+          @adapters << adapter
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/kabutops/crawler_extensions/pstore_storage.rb

@@ -0,0 +1,27 @@
+module Kabutops
+
+  module CrawlerExtensions
+
+    module PStoreStorage
+
+      def check_storage
+        @storage ||= PStore.new(".kabutopus.config.pstore")
+      end
+
+      def storage= name, value
+        check_storage
+        @storage.transaction do
+          @storage[key.to_sym] = value
+        end
+      end
+
+      def storage key
+        check_storage
+        @storage.transaction { @storage[key.to_sym] }
+      end
+
+    end
+
+  end
+
+end

data/lib/kabutops/recipe.rb

@@ -0,0 +1,49 @@
+module Kabutops
+  class Recipe
+    def initialize
+      @items = {}
+      @nested = false
+    end
+
+    def method_missing name, *args, &block
+      if block_given?
+        recipe = Recipe.new
+        recipe.instance_eval &block
+        @items[name] = RecipeItem.new(name, :recipe, recipe)
+        @nested = true
+      else
+        type, value = args[0..1]
+        @items[name] = RecipeItem.new(name, type, value)
+      end
+    end
+
+    def process resource, page
+      result = {}
+
+      @items.each do |name, item|
+        result[name] = case item.type
+        when :var
+          resource[item.value]
+        when :recipe
+          item.value.process(resource, page)
+        when :css
+          page.css(item.value).text
+        when :xpath
+          page.xpath(item.value).text
+        when :lambda
+          item.value.call(page)
+        when :proc
+          page.instance_eval &item.value
+        else
+          raise "unknown recipe item type '#{item.type}'"
+        end
+      end
+
+      result
+    end
+
+    def nested?
+      @nested
+    end
+  end
+end

data/lib/kabutops/recipe_item.rb

@@ -0,0 +1,11 @@
+module Kabutops
+  class RecipeItem
+    attr_reader :name, :type, :value
+
+    def initialize name, type, value
+      @name = name
+      @type = type
+      @value = value
+    end
+  end
+end

data/lib/kabutops/version.rb

@@ -0,0 +1,3 @@
+module Kabutops
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: kabutops
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rene Klacan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cachy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: ''
+email: rene@klacan.sk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/kabutops.rb
+- lib/kabutops/adapters/database_adapter.rb
+- lib/kabutops/adapters/callback.rb
+- lib/kabutops/adapters/mysql.rb
+- lib/kabutops/adapters/elastic_search.rb
+- lib/kabutops/crawler_extensions/pstore_storage.rb
+- lib/kabutops/crawler_extensions/callback.rb
+- lib/kabutops/crawler_extensions/mysql.rb
+- lib/kabutops/crawler_extensions/elastic_search.rb
+- lib/kabutops/recipe.rb
+- lib/kabutops/version.rb
+- lib/kabutops/recipe_item.rb
+- lib/kabutops/crawler.rb
+- LICENSE
+- README.md
+homepage: https://github.com/reneklacan/kabutops
+licenses:
+- Beerware
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []