trio-blog-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e6cb60631072856ce21f721aee1df3c8aa362dcca8aea76bf4bb8a9b709637d
+  data.tar.gz: 1c1da6fbb1be0603e98de941d1408a4e2db5786f166577812fb39c66177c621c
+SHA512:
+  metadata.gz: 6559bec31d05544f804e1475ba4330907fee63faa4b8ff5900708b1fc441ea0b856706c2439547d6d1693f4903885d5c82d34eb7b3e5085ea0dc6cd9b16ad326
+  data.tar.gz: 06f82edae7798cda73283a2c550e952cc1db4eb87e7c3e254f8b988f6704267b02c897aba6e1df232ef699b6ef69d438d69c84de1b15950511405aa62215d97a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    trio-blog-api (0.1.0)
+      nokogiri (~> 1.10)
+      typhoeus (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.11.1)
+    mini_portile2 (2.4.0)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rake (10.4.0)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  trio-blog-api!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019
+
+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,67 @@
+# Trio Blog API
+
+This gem was created as a object of study in [my blog post](http://trio.dev). It's a simple API to make it easier to fetch the last Trio blog post.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trio-blog-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install trio-blog-api
+
+## Usage
+
+You can fetch the last blog post with:
+
+```ruby
+require "trio-blog-api"
+
+Trio::Blog::API.fetch_last_post.to_h
+
+{:title=>"7 Healthy Habits Of A Remote Software Developer",
+ :thumbnail_image_url=>
+  "https://res.cloudinary.com/usetrio/image/upload/h_270,c_scale/v1564583137/nolomx0dhkdjdd9zq8fo.jpg",
+ :post_url=>
+  "https://trio.dev/blog/7-healthy-habits-of-a-remote-software-developer-67133",
+ :author=>
+  {:name=>"Dhyego Calota",
+   :avatar_image_url=>
+    "https://res.cloudinary.com/usetrio/image/upload/h_90,c_scale/v1553087570/uwaslkbvubggrh8rul30.jpg"}}
+```
+
+## Settings
+
+| Option                             | Type     | Default                      | Description                                      |
+| ---------------------------------- | -------- | ---------------------------- | ------------------------------------------------ |
+| `base_url`                         | *String* | `http://trio.dev`            | Base URL of trio's website                       |
+| `post_page_path`                   | *String* | `/`                          | Post page path URL that contains the last post   |
+| `post_selector`                    | *String* | `.card-article`              | CSS selector of the post wrapper element         |
+| `title_selector`                   | *String* | `.card-article-title`        | CSS selector of the post title element           |
+| `thumbnail_image_url_selector`     | *String* | `.card-article-thumb`        | CSS selector of the post thumbnail image element |
+| `post_url_selector`                | *String* | `.card-article-link`         | CSS selector of the post link element            |
+| `author_name_selector`             | *String* | `.card-article-author-name`  | CSS selector of the post author name element     |
+| `author_avatar_image_url_selector` | *String* | `.card-article-author-image` | CSS selector of the post author avatar element   |
+
+### Usage
+```ruby
+Trio::Blog::API.configure do |config|
+  config.post_selector = '.card-article:first-child'
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/usetrio/trio-blog-api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "trio/blog/api"
+
+# 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/lib/trio/blog/api/config.rb

@@ -0,0 +1,48 @@
+module Trio
+  module Blog
+    module API
+      class Config
+        attr_writer :base_url,
+                    :post_page_path,
+                    :post_selector,
+                    :title_selector,
+                    :thumbnail_image_url_selector,
+                    :post_url_selector,
+                    :author_name_selector,
+                    :author_avatar_image_url_selector
+
+        def base_url
+          @base_url ||= 'https://trio.dev'
+        end
+
+        def post_page_path
+          @post_page_path ||= '/'
+        end
+
+        def post_selector
+          @post_selector ||= '.card-article'
+        end
+
+        def title_selector
+          @title_selector ||= '.card-article-title'
+        end
+
+        def thumbnail_image_url_selector
+          @thumbnail_image_url_selector ||= '.card-article-thumb'
+        end
+
+        def post_url_selector
+          @post_url_selector ||= '.card-article-link'
+        end
+
+        def author_name_selector
+          @author_name_selector ||= '.card-article-author-name'
+        end
+
+        def author_avatar_image_url_selector
+          @author_avatar_image_url_selector ||= '.card-article-author-image'
+        end
+      end
+    end
+  end
+end

data/lib/trio/blog/api/document_reader.rb

@@ -0,0 +1,14 @@
+module Trio
+  module Blog
+    module API
+      class DocumentReader
+        attr_reader :document, :config
+
+        def initialize(document, config)
+          @document = document
+          @config = config
+        end
+      end
+    end
+  end
+end

data/lib/trio/blog/api/error/empty_attribute_error.rb

@@ -0,0 +1,14 @@
+module Trio
+  module Blog
+    module API
+      class EmptyAttributeError < Error
+        attr_reader :attribute_name
+
+        def initialize(attribute_name)
+          super("Empty attribute value for '#{attribute_name}'")
+          @attribute_name = attribute_name
+        end
+      end
+    end
+  end
+end

data/lib/trio/blog/api/error/error.rb

@@ -0,0 +1,7 @@
+module Trio
+  module Blog
+    module API
+      class Error < StandardError; end
+    end
+  end
+end

data/lib/trio/blog/api/error/response_error.rb

@@ -0,0 +1,14 @@
+module Trio
+  module Blog
+    module API
+      class ResponseError < Error
+        attr_reader :response
+
+        def initialize(response)
+          super(response.return_message)
+          @response = response
+        end
+      end
+    end
+  end
+end

data/lib/trio/blog/api/error/selector_not_found_error.rb

@@ -0,0 +1,14 @@
+module Trio
+  module Blog
+    module API
+      class SelectorNotFoundError < Error
+        attr_reader :selector
+
+        def initialize(selector)
+          super("Element not found with '#{selector}' selector")
+          @selector = selector
+        end
+      end
+    end
+  end
+end

data/lib/trio/blog/api/post_attributes.rb

@@ -0,0 +1,41 @@
+require "uri"
+
+module Trio
+  module Blog
+    module API
+      class PostAttributes < DocumentReader
+        attr_reader :selectors
+
+        def initialize(selectors, document, config)
+          super(document, config)
+          @selectors = selectors
+        end
+
+        def title
+          selectors.title_element.text || raise(EmptyAttributeError.new(__method__))
+        end
+
+        def thumbnail_image_url
+          selectors.thumbnail_image_element.attr("data-src") || raise(EmptyAttributeError.new(__method__))
+        end
+
+        def post_url
+          post_url = selectors.post_link_element.attr("href") || raise(EmptyAttributeError.new(__method__))
+          parsed_post_url = URI.parse(post_url)
+          base_url = URI.parse(config.base_url)
+          parsed_post_url.host = base_url.host
+          parsed_post_url.scheme = base_url.scheme
+          parsed_post_url.to_s
+        end
+
+        def author_name
+          selectors.author_name_element.text || raise(EmptyAttributeError.new(__method__))
+        end
+
+        def author_avatar_image_url
+          selectors.author_avatar_image_element.attr("data-src") || raise(EmptyAttributeError.new(__method__))
+        end
+      end
+    end
+  end
+end

data/lib/trio/blog/api/post_reader.rb

@@ -0,0 +1,27 @@
+module Trio
+  module Blog
+    module API
+      class PostReader < DocumentReader
+        def selectors
+          @selectors ||= PostSelectors.new(document, config)
+        end
+
+        def attributes
+          @attributes ||= PostAttributes.new(selectors, document, config)
+        end
+
+        def to_h
+          {
+              title: attributes.title,
+              thumbnail_image_url: attributes.thumbnail_image_url,
+              post_url: attributes.post_url,
+              author: {
+                  name: attributes.author_name,
+                  avatar_image_url: attributes.author_avatar_image_url
+              }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/trio/blog/api/post_selectors.rb

@@ -0,0 +1,31 @@
+module Trio
+  module Blog
+    module API
+      class PostSelectors < DocumentReader
+        def post_element
+          document.css(config.post_selector).first || raise(SelectorNotFoundError.new(config.post_selector))
+        end
+
+        def title_element
+          post_element.css(config.title_selector).first || raise(SelectorNotFoundError.new(config.title_selector))
+        end
+
+        def thumbnail_image_element
+          post_element.css(config.thumbnail_image_url_selector).first || raise(SelectorNotFoundError.new(config.thumbnail_image_url_selector))
+        end
+
+        def post_link_element
+          post_element.css(config.post_url_selector).first || raise(SelectorNotFoundError.new(config.post_url_selector))
+        end
+
+        def author_name_element
+          post_element.css(config.author_name_selector).first || raise(SelectorNotFoundError.new(config.author_name_selector))
+        end
+
+        def author_avatar_image_element
+          post_element.css(config.author_avatar_image_url_selector).first || raise(SelectorNotFoundError.new(config.author_avatar_image_url_selector))
+        end
+      end
+    end
+  end
+end

data/lib/trio/blog/api/version.rb

@@ -0,0 +1,7 @@
+module Trio
+  module Blog
+    module API
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/trio/blog/api.rb

@@ -0,0 +1,34 @@
+require "typhoeus"
+require "nokogiri"
+require "trio/blog/api/version"
+require "trio/blog/api/config"
+require "trio/blog/api/document_reader"
+require "trio/blog/api/post_reader"
+require "trio/blog/api/post_selectors"
+require "trio/blog/api/post_attributes"
+require "trio/blog/api/error/error"
+require "trio/blog/api/error/response_error"
+require "trio/blog/api/error/selector_not_found_error"
+require "trio/blog/api/error/empty_attribute_error"
+
+module Trio
+  module Blog
+    module API
+      extend self
+
+      def config
+        @config ||= Config.new
+      end
+
+      def configure
+        yield config
+      end
+
+      def fetch_last_post
+        response = Typhoeus.get(config.base_url)
+        raise ResponseError.new(response) unless response.success?
+        PostReader.new(Nokogiri::HTML(response.body), config)
+      end
+    end
+  end
+end

data/trio-blog-api.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "trio/blog/api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "trio-blog-api"
+  spec.version       = Trio::Blog::API::VERSION
+  spec.authors       = ["Dhyego Calota"]
+  spec.email         = ["dhyego@usetrio.com"]
+
+  spec.summary       = %q{This gem is an API to make it easier to fetch the last Trio blog post.}
+  spec.homepage      = "https://github.com/usetrio/trio-blog-api"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "typhoeus", "~> 1.3"
+  spec.add_dependency "nokogiri", "~> 1.10"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: trio-blog-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dhyego Calota
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+description: 
+email:
+- dhyego@usetrio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/trio/blog/api.rb
+- lib/trio/blog/api/config.rb
+- lib/trio/blog/api/document_reader.rb
+- lib/trio/blog/api/error/empty_attribute_error.rb
+- lib/trio/blog/api/error/error.rb
+- lib/trio/blog/api/error/response_error.rb
+- lib/trio/blog/api/error/selector_not_found_error.rb
+- lib/trio/blog/api/post_attributes.rb
+- lib/trio/blog/api/post_reader.rb
+- lib/trio/blog/api/post_selectors.rb
+- lib/trio/blog/api/version.rb
+- trio-blog-api.gemspec
+homepage: https://github.com/usetrio/trio-blog-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/usetrio/trio-blog-api
+  source_code_uri: https://github.com/usetrio/trio-blog-api
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: This gem is an API to make it easier to fetch the last Trio blog post.
+test_files: []