dev_to 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 634c48b237c94fda45d5b012654767719130c24dfcb705d6c2017ecd26c9bfdb
-  data.tar.gz: 49a4e5ea3ceeacf8139c46ec25388df50a7e81405382cb2254a8a5d85df5253d
+  metadata.gz: dcad7a42a07025c32e36148df95270a8171e4382ae084ced30f190ff66b680d0
+  data.tar.gz: 8dec72f52ed88d6f66ea9bb269aa0f66442d5b40cd4b019a3af7c7041f502b4a
 SHA512:
-  metadata.gz: aedc5efc701c996d64d7ebba46ace75019d80cd51afa23155aab9ebaf3bb9b8270a883b1328dda1915cecae0138163bcccc1212fb3129ded46d776fc7551ccae
-  data.tar.gz: 21db14182ebd0a3420226c3169bc10035978737936149d8c73dbe75bb8cfdf3092de69abba4da056c164aaf5a462dab407e1453ef2cd2fdba8e07b88c7ee99ef
+  metadata.gz: ac2d997c81905d89e40f62f286120cbc1fd12074a7c89ac8fe9566f9f769945d9a687d77e89cc8e57d8f1de0bcf8ad2697f3cfa614adc99da7d0e7696ce0989c
+  data.tar.gz: 91ee7ddbdab786e46ae30d789f73cb0ff79b89775eee637d92f2ed922a0d4ed4337d12da97a1ce07f9b2c8692bbbc66cc2a2426f4e9ec0e33fc7f3954296837a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

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 https://github.com/PRbsas. 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 dev_to.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 PRbsas
+
+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,32 @@
+# DevTo CLI GEM
+
+[![Gem Version](https://badge.fury.io/rb/dev_to.svg)](https://badge.fury.io/rb/dev_to)  
+
+This Ruby Gem provides a CLI to view posts from The DEV Community, [dev.to](https://dev.to/). It is published in [rubygems.org](https://rubygems.org/gems/dev_to).
+
+## Installation
+
+    $ gem install dev_to
+
+## Usage
+
+After installing the gem run the command below:
+
+    $ devto
+
+## Development
+
+To run the development version of the CLI run `bundle exec bin/devto`
+
+
+## Contributing
+
+1. Fork it ( https://github.com/PRbsas/devto-cli-gem/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 new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dev_to"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/environment.rb

@@ -0,0 +1,9 @@
+require 'pry'
+require 'nokogiri'
+require 'open-uri'
+require 'colorize'
+
+require_relative '../lib/dev_to/version'
+require_relative '../lib/dev_to/cli'
+require_relative '../lib/dev_to/post'
+require_relative '../lib/dev_to/scraper'

data/dev_to.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dev_to/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dev_to"
+  spec.version       = DevTo::VERSION
+  spec.authors       = ["PRbsas"]
+  spec.email         = ["paularamirez0316@gmail.com"]
+
+  spec.summary       = %q{Get Posts in yout CLI from The DEV Community}
+  spec.description   = %q{Application that provides a Command Line Interface (CLI) to read Posts from The DEV Community, https://dev.to/}
+  spec.homepage      = "https://github.com/PRbsas/devto-cli-gem"
+  spec.license       = "MIT"
+  
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   << 'devto'
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "nokogiri", "~> 1.6", ">= 1.6.8"
+  spec.add_development_dependency "pry", "~> 0.11.2"
+  spec.add_dependency "colorize", "~> 0.8.1"
+end

data/lib/dev_to.rb

@@ -0,0 +1,4 @@
+require_relative '../config/environment'
+
+module DevTo
+end

data/lib/dev_to/cli.rb

@@ -0,0 +1,60 @@
+class DevTo::CLI
+
+  def call
+    DevTo::Scraper.new.make_posts
+    puts
+    puts "< Welcome to your DEV Community FEED >".colorize(:color => :light_white, :background => :red)
+    puts
+    list_posts
+    start
+  end
+
+  def list_posts
+    DevTo::Post.all.each.with_index(1) do |post, i|
+      puts
+      puts "#{i}. #{post.title} - #{post.author}"
+      puts " -------- #{post.tags.join(" · ")}     \u{1F4AC} #{post.comments}  \u{2764} #{post.likes}"
+    end
+  end
+
+  def print_post(post)
+    puts
+    puts
+    puts "#{post.title}".colorize(:color => :light_white, :background => :red)
+    puts " ---- #{post.author}   ---- #{post.date}"
+    puts
+    puts "#{post.content}"
+    puts
+    puts " ---- #{post.tags.join(" · ")}     \u{1F4AC} #{post.comments}  \u{2764} #{post.likes}"
+    puts " ---- #{post.url}"
+    puts
+  end
+
+  def start
+    input = nil
+    post = nil
+    while input != "exit"
+      puts
+      puts "< Type post NUMBER to read it >"
+      puts "< Type LIST to see the posts again >"
+      puts "< Type EXIT to end program >"
+
+      input = gets.strip.downcase
+      if input == "list"
+        list_posts
+      elsif input.to_i.between?(1, DevTo::Post.all.size)
+        post = DevTo::Post.find(input)
+        DevTo::Scraper.new.make_content(post)
+        print_post(post)
+        puts "< Type OPEN to see it in the browser >"
+        post
+      elsif input.to_i > DevTo::Post.all.size
+        puts
+        puts " -------- Please select a valid option:"
+      elsif input == "open" && post != nil
+          system("open #{post.url}")
+      end
+    end
+    puts " -------- See you soon for more DEV Posts"
+  end
+end

data/lib/dev_to/post.rb

@@ -0,0 +1,17 @@
+class DevTo::Post
+  attr_accessor :title, :author, :tags, :url, :comments, :likes, :date, :content
+
+  @@all = []
+
+  def initialize
+    self.class.all << self
+  end
+
+  def self.find(id)
+    self.all[id.to_i-1]
+  end
+
+  def self.all
+    @@all
+  end
+end

data/lib/dev_to/scraper.rb

@@ -0,0 +1,29 @@
+class DevTo::Scraper
+
+  def get_page
+    Nokogiri::HTML(open("https://dev.to/"))
+  end
+
+  def get_posts
+    self.get_page.css(".articles-list .substories .single-article")
+  end
+
+  def make_posts
+    self.get_posts.each do |data|
+      post = DevTo::Post.new
+      post.title = data.search(".content h3 span").remove
+      post.title = data.search(".content h3").text.strip.gsub(/[[:space:]]+/," ")
+      post.author = data.search("h4").text.strip
+      post.tags = data.search(".tags .tag").collect { |tag| tag.text.strip}
+      post.url = "https://dev.to" + data.search("a").last.attr("href")
+      post.comments = data.search(".engagement-count-number").first.text.strip
+      post.likes = data.search(".engagement-count-number").last.text.strip
+    end
+  end
+
+  def make_content(post)
+    post_page = Nokogiri::HTML(open("#{post.url}"))
+    post.content = post_page.search("body #article-body").text.strip
+    post.date = post_page.search("#main-title .published-at").text.strip
+  end
+end

data/lib/dev_to/version.rb

@@ -0,0 +1,3 @@
+module DevTo
+  VERSION = "0.1.2"
+end

data/spec.md

@@ -0,0 +1,13 @@
+# Specifications for the CLI Assessment
+
+Specs:  
+
+- [X] Have a CLI for interfacing with the application  
+  The user interacts with the application through the CLI. Getting prompted for input from the start of the program.  
+
+- [X] Pull data from an external source  
+  The data the CLI shows is scraped with Nokogiri and open-uri from [dev.to](https://dev.to/)
+
+- [X] Implement both list and detail views  
+  When the program runs, the Scraper class gets called with the method #make-posts that instantiates new instances of Post. The CLI method #list-posts then iterates through the instances of Post and prints them for the user.  
+  When the user types in a post number to read, the CLI uses the Post #find method to find the Post. It then calls the Scraper method #make-content to scrape the content of the post and prints it for the user with the #print-post method.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dev_to
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - PRbsas
@@ -109,7 +109,28 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
 - bin/devto
+- bin/setup
+- config/environment.rb
+- dev_to-0.1.0.gem
+- dev_to-0.1.1.gem
+- dev_to.gemspec
+- lib/dev_to.rb
+- lib/dev_to/cli.rb
+- lib/dev_to/post.rb
+- lib/dev_to/scraper.rb
+- lib/dev_to/version.rb
+- spec.md
 homepage: https://github.com/PRbsas/devto-cli-gem
 licenses:
 - MIT
@@ -117,7 +138,7 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- lib/dev_to.rb, config/environment.rb
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="