dh_easy 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c0dc1ab1c61908614f1002368b5f2e97d21f5b0a090d371b310c13070e2e8f2e
+  data.tar.gz: 46d8272ab380fb644295ced234a3d261e1a4c947a0e6877306c6686b23a1cf7e
+SHA512:
+  metadata.gz: cabc9a8c2b39147c40f1e814759900fa8d5972de976525764a78fd09542bfc9a5a6d561799dcd96e194051a7f4f96e82df81bdc39595f2241e6865bc95cfaba4
+  data.tar.gz: ae17f259f68dffc789cb25bea49cdb1d75aca073677bf029c22a50f7274ecc8aae924490d621a0fd64f568064851cd6b54aa2d2465d91ca5ecef09feafcec3a0

data/.gitignore

@@ -0,0 +1,13 @@
+/.byebug*
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/pkg/
+/spec/reports/
+/tmp/
+!/tmp/.keep
+/certs/
+/checksum/
+/vendor/
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.3

data/.yardopts

@@ -0,0 +1 @@
+--no-private

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at perry@datahen.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dh_easy.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 DataHen
+
+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,267 @@
+[![Gem Version](https://badge.fury.io/rb/dh_easy.svg)](http://github.com/DataHenOfficial/dh_easy/releases)
+[![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
+
+# DhEasy
+## Description
+
+DhEasy gem collection allow advance DataHen features possible by including a collection of specialized gems.
+
+Install gem:
+```ruby
+gem install 'dh_easy'
+```
+
+Require gem:
+```ruby
+require 'dh_easy'
+```
+
+Included gems documentation:
+```
+dh_easy-core: http://rubydoc.org/gems/dh_easy-core/frames
+dh_easy-config: http://rubydoc.org/gems/dh_easy-config/frames
+dh_easy-router: http://rubydoc.org/gems/dh_easy-router/frames
+dh_easy-text: http://rubydoc.org/gems/dh_easy-text/frames
+dh_easy-login: http://rubydoc.org/gems/dh_easy-login/frames
+```
+
+## How to implement
+
+### Sample DataHen project
+
+Lets take a simple project without `dh_easy`:
+
+```yaml
+# ./config.yaml
+
+seeder:
+  file: ./seeder/seeder.rb
+  disabled: false
+parsers:
+  - page_type: search
+    file: ./parsers/search.rb
+    disabled: false
+  - page_type: product
+    file: ./parsers/product.rb
+    disabled: false
+```
+
+```ruby
+# ./seeder/seeder.rb
+
+pages << {
+  'url' => 'https://example.com/login.rb?query=food',
+  'page_type' => 'search'
+}
+```
+
+```ruby
+# ./parsers/search.rb
+
+require 'cgi'
+
+html = Nokogiri.HTML content
+html.css('.name').each do |element|
+  name = element.text.strip
+  pages << {
+    'url' => "https://example.com/product/#{CGI::escape name}",
+    'page_type' => 'product',
+    'vars' => {'name' => name}
+  }
+end
+```
+
+```ruby
+# ./parsers/product.rb
+
+html = Nokogiri.HTML content
+description = html.css('.description').first.text.strip
+outputs << {
+  '_collection' => 'product',
+  'name' => page['vars']['name'],
+  'description' => description
+}
+```
+
+### Adding dh_easy to sample project
+
+One of DhEasy's main feature is to allow users to use classes instead of raw scripts with the whole `datahen` gem contexts (seeder, parsers, finishers, etc.) functions and objects integreated directly on our classes.
+
+Converting seeders, parsers and finishers to DhEasy supported classes is quite easy, just wrap your seeders and parsers like this:
+
+```ruby
+class MySeeder
+  include DhEasy::Core::Plugin::Seeder
+
+  # Create "initialize_hook_*" methods instead of "initialize" method
+  #  to prevent overriding the logic behind DhEasy
+  def initialize_hook_my_seeder opts = {}
+    @my_param = opts[:my_param]
+  end
+
+  def seed
+
+    # Your seeder code goes here
+
+  end
+end
+```
+
+```ruby
+class MyParser
+  include DhEasy::Core::Plugin::Parser
+
+  # Create "initialize_hook_*" methods instead of "initialize" method
+  #  to prevent overriding the logic behind DhEasy
+  def initialize_hook_my_parser opts = {}
+    @my_param = opts[:my_param]
+  end
+
+  def parse
+
+    # Your parser code goes here
+
+  end
+end
+```
+
+```ruby
+class MyFinisher
+  include DhEasy::Core::Plugin::Finisher
+
+  # Create "initialize_hook_*" methods instead of "initialize" method
+  #  to prevent overriding the logic behind DhEasy
+  def initialize_hook_my_parser opts = {}
+    @my_param = opts[:my_param]
+  end
+
+  def finish
+
+    # Your finisher code goes here
+
+  end
+end
+```
+
+You can also add `initialize_hook_` methods to extend the default `initialize` provided by DhEasy plugins.
+
+Now let's try this on our sample project's seeders and parsers:
+
+```ruby
+# ./seeder/seeder.rb
+
+module Seeder
+  class Seeder
+    include DhEasy::Core::Plugin::Seeder
+
+    def seed
+      pages << {
+        'url' => 'https://example.com/search?query=food',
+        'page_type' => 'search'
+      }
+    end
+  end
+end
+```
+
+```ruby
+# ./parsers/search.rb
+
+module Parsers
+  class Search
+    include DhEasy::Core::Plugin::Parser
+
+    def parse
+      html = Nokogiri.HTML content
+      html.css('.name').each do |element|
+        name = element.text.strip
+        pages << {
+          'url' => "https://example.com/product/#{CGI::escape name}",
+          'page_type' => 'product',
+          'vars' => {'name' => name}
+        }
+      end
+    end
+  end
+end
+```
+
+```ruby
+# ./parsers/product.rb
+
+module Parsers
+  class Product
+    include DhEasy::Core::Plugin::Parser
+
+    def parse
+      html = Nokogiri.HTML content
+      description = html.css('.description').first.text.strip
+      outputs << {
+        '_collection' => 'product',
+        'name' => page['vars']['name'],
+        'description' => description
+      }
+    end
+  end
+end
+```
+
+Next step is to add router capabilities to consume these classes. To do this, let's create the routers and require our seeder and parsers classes, like this:
+
+```ruby
+# ./router/seeder.rb
+
+require 'dh_easy/router'
+require './seeder/seeder'
+
+DhEasy::Router::Seeder.new.route context: self
+```
+
+```ruby
+# ./router/parser.rb
+
+require 'cgi'
+require 'dh_easy/router'
+require './parsers/search'
+require './parsers/product'
+
+DhEasy::Router::Parser.new.route context: self
+```
+
+Now lets create our `./dh_easy.yaml` config file to link our routers to our new seeder and parsers classes:
+
+```yaml
+# ./dh_easy.yaml
+
+router:
+  parser:
+    routes:
+      - page_type: search
+        class: Parsers::Search
+      - page_type: product
+        class: Parsers::Product
+
+  seeder:
+    routes:
+      - class: Seeder::Seeder
+```
+
+Finally, we need to modify our `./config.yaml` to use our routers:
+
+```yaml
+# ./config.yaml
+
+seeder:
+  file: ./router/seeder.rb
+  disabled: false
+
+parsers:
+  - page_type: search
+    file: ./router/parser.rb
+    disabled: false
+  - page_type: product
+    file: ./router/parser.rb
+    disabled: false
+```
+
+Hurray! you have successfullly implemented DhEasy on your project.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'benchmark'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ['lib', 'test']
+  t.warning = false
+  t.verbose = false
+  t.test_files = FileList['./test/**/*_test.rb']
+end
+
+desc 'Benchmark another task execution | usage example: benchmark[my_task, param1, param2]'
+task :benchmark, [:task] do |task, args|
+  task_name = args[:task]
+  if task_name.nil?
+    puts "Should select a task."
+    exit 1
+  end
+  puts Benchmark.measure{ Rake::Task[task_name].invoke *args.extras }
+end
+
+task default: :test

data/dh_easy.gemspec

@@ -0,0 +1,52 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dh_easy/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dh_easy"
+  spec.version       = DhEasy::VERSION
+  spec.authors       = ["Eduardo Rosales"]
+  spec.email         = ["eduardo@datahen.com"]
+
+  spec.summary       = %q{DataHen Easy toolkit modules.}
+  spec.description   = %q{DataHen Easy toolkit module collection.}
+  spec.homepage      = "https://datahen.com"
+  spec.license       = "MIT"
+
+  # spec.cert_chain  = ['certs/dh_easy.pem']
+  # spec.signing_key = File.expand_path("~/.ssh/gems/gem-private_dh_easy.pem") if $0 =~ /gem\z/
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/DataHenOfficial/dh_easy"
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.2.2'
+
+  spec.add_dependency 'dh_easy-core', '>= 0'
+  spec.add_dependency 'dh_easy-config', '>= 0'
+  spec.add_dependency 'dh_easy-text', '>= 0'
+  spec.add_dependency 'dh_easy-router', '>= 0'
+  spec.add_dependency 'dh_easy-login', '>= 0'
+  spec.add_development_dependency 'bundler', '>= 1'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'simplecov', '~> 0'
+  spec.add_development_dependency 'simplecov-console', '~> 0'
+  spec.add_development_dependency 'byebug', '>= 0'
+end