tsumamigui 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 702bd3c5943152c61e828f79d68bc059460363ff
-  data.tar.gz: 6f6be749c0196295c44358b0bfabce7d4619606b
+  metadata.gz: 56fa99aed4b2fe61611547e801cbd2ad15896abf
+  data.tar.gz: 5e573542ae77da0b3b39a4113af032ab0a4a1996
 SHA512:
-  metadata.gz: 5a920877f1b894b38b5277d8b077012167e2eea426fbbc4eaa314a7f2f56fb89b303d8204ed814caa7304477bf99483306f55c2aaba0868b55fae4f6d0bae33c
-  data.tar.gz: 9c4b7820057f016b6711b665269d9322316f186f8170ced9becae1d6c7e3c2877c828a11ed852e2a0ff21d2548fb1168da47c998c08b2f8e3dcd2283baa914bf
+  metadata.gz: 3abaced2852c68fc95646b3eb006d5076d391626c173d2760fec1475d6f100d273795693fa9d2dbe7ede76827c8ced1bcb9f901ce6534de976a7f036a0234587
+  data.tar.gz: ae8e0cab6e93a2740092fa94acaa25c8b156cc499f468cbbc54a54f6f7094ef0558204a6d0e58c72c823c2510b8756b6378e75f91f98dac008a0c4d9eb4acf02

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# 0.1.2 / 2017-10-24
+
+## Notes
+
+* Revise code comments :memo:
+
+# 0.1.1 / 2017-07-12 
+
+## Bug fixes
+
+* Fix lint error :bug:
+
+# 0.1.0 / 2017-07-12
+
+`Tsumamigui` has been released! :tada:
+
+## Features
+
+* Scrape urls with xpath.

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 obi.yuta@gmail.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/README.md

@@ -1,5 +1,5 @@
 # Tsumamigui
-[![Gem Version](https://badge.fury.io/rb/tsumamigui.svg)](https://badge.fury.io/rb/tsumamigui) ![circleci](https://circleci.com/gh/obiyuta/tsumamigui.svg?&style=shield&circle-token=8e2bda0f04504c2fe43d3fe70ea8ab1b6184806f) [![Code Climate](https://codeclimate.com/github/obiyuta/tsumamigui/badges/gpa.svg)](https://codeclimate.com/github/obiyuta/tsumamigui) [![Test Coverage](https://codeclimate.com/github/obiyuta/tsumamigui/badges/coverage.svg)](https://codeclimate.com/github/obiyuta/tsumamigui/coverage) [![Dependency Status](https://gemnasium.com/badges/github.com/obiyuta/tsumamigui.svg)](https://gemnasium.com/github.com/obiyuta/tsumamigui) [![Inline docs](http://inch-ci.org/github/obiyuta/tsumamigui.svg?branch=master)](http://inch-ci.org/github/obiyuta/tsumamigui)
+[![Gem Version](https://badge.fury.io/rb/tsumamigui.svg)](https://badge.fury.io/rb/tsumamigui) [![circleci](https://circleci.com/gh/obiyuta/tsumamigui.svg?&style=shield&circle-token=8e2bda0f04504c2fe43d3fe70ea8ab1b6184806f)](https://circleci.com/gh/obiyuta/tsumamigui/tree/master) [![Code Climate](https://codeclimate.com/github/obiyuta/tsumamigui/badges/gpa.svg)](https://codeclimate.com/github/obiyuta/tsumamigui) [![Test Coverage](https://codeclimate.com/github/obiyuta/tsumamigui/badges/coverage.svg)](https://codeclimate.com/github/obiyuta/tsumamigui/coverage) [![Dependency Status](https://gemnasium.com/badges/github.com/obiyuta/tsumamigui.svg)](https://gemnasium.com/github.com/obiyuta/tsumamigui) [![Inline docs](http://inch-ci.org/github/obiyuta/tsumamigui.svg?branch=master)](http://inch-ci.org/github/obiyuta/tsumamigui)
 
 Tsumamigui（つまみぐい） is a simple and hussle-free Ruby web scraping library.
 
@@ -52,7 +52,6 @@ ___Important:___ Tsumamigui requests each urls at intervals of 1.0~3.0sec automa
 ## TODO
 
 - [ ] Custom request headers.
-- [ ] SSL support. (unchecked)
 
 etc...
 

data/lib/tsumamigui/parser.rb

@@ -3,12 +3,13 @@ require 'tsumamigui/error'
 
 module Tsumamigui
   class Parser
+    # xpath to getting the data from
     attr_reader :xpath
 
     class << self
       # @param [Array<Tsumamigui::Response>] responses
       # @param [Hash] xpath
-      # @return [Array<Hash>]
+      # @return [Array<Hash>] parsed responses
       def parse(responses, xpath)
         new(xpath).send(:parse, responses)
       end
@@ -21,7 +22,9 @@ module Tsumamigui
 
     private
 
-    # @return [Array<Tsumamigui::Response>] responses
+    # Parse response data into hash object
+    # @param [Array<Tsumamigui::Response>] responses
+    # @return [Array<Hash>] parsed responses
     # @raise [Tsumamigui::ParserError]
     def parse(responses)
       results = []
@@ -36,13 +39,14 @@ module Tsumamigui
       raise ParserError, e.message
     end
 
+    # Extract data from parsed html with xpath
     # @param [Object] document Nokogiri::HTML::Document
-    # @return [Hash]
+    # @return [Hash] xpath and its key
     # @raise [Tsumamigui::ParserError]
-    def extract(doc)
+    def extract(document)
       result = {}
       @xpath.each do |k, v|
-        result[k] = doc.xpath(v).to_s
+        result[k] = document.xpath(v).to_s
       end
       result
     rescue => e

data/lib/tsumamigui/request.rb

@@ -7,7 +7,7 @@ module Tsumamigui
     class << self
       # @param [String] urls
       # @param [Array<String>] urls
-      # @return [Array<Tsumamigui::Response>]
+      # @return [Array<Tsumamigui::Response>] response instances
       def run(*urls)
         new(urls).send(:run)
       end
@@ -27,7 +27,8 @@ module Tsumamigui
 
     private
 
-    # @return [Array<Tsumamigui::Response>]
+    # Execute request and return responses
+    # @return [Array<Tsumamigui::Response>] response instances
     def run
       results = []
       @urls.each do |url|
@@ -36,6 +37,7 @@ module Tsumamigui
       results
     end
 
+    # Fetch HTML from url and convert to response object
     # @param [String] url
     # @return [Tsumamigui::Response] response
     # @raise [Tsumamigui::RequestError]

data/lib/tsumamigui/response.rb

@@ -1,7 +1,10 @@
 module Tsumamigui
   class Response
+    # request url
     attr_reader :url
+    # fetched html
     attr_reader :html
+    # charset of fetched html
     attr_reader :charset
 
     # @param [String] url
@@ -13,7 +16,8 @@ module Tsumamigui
       @charset = charset
     end
 
-    # @return [Array]
+    # Convert request data to array
+    # @return [Array] [url, html, charset]
     def to_array
       [@url, @html, @charset]
     end

data/lib/tsumamigui/version.rb

@@ -1,3 +1,3 @@
 module Tsumamigui
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tsumamigui
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - obiyuta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -161,6 +161,8 @@ files:
 - ".pryrc"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md