forem_lite 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d48565de3831a44026c784304d5c5ee3cee6681cf51b4d7ce822f47f464a4bf4
+  data.tar.gz: 74416fef674abcf874291933244cb662548a1c4f0608f590c41da3e88255302a
+SHA512:
+  metadata.gz: a6d9e8067c168a6fba7cb74a879189a2b7c2ed97a57b93adadb158594b03add991eea7af972dbd5f8e32713cfdd5c2733a212d75f5215b7a7b41a4c84ab85f0b
+  data.tar.gz: e5b229948a76603307c6a036271fefca2cacd4db8a1449aefac7cf55c670a74efb5911f0d9eb4f836f286ecc4dd6938c9ee047b67ab712cf76e4c5706db3a27c

data/.gem_release.yml

@@ -0,0 +1,3 @@
+bump:
+  file: lib/forem_lite/version.rb
+  message: "chore(release): :bookmark: Bump %{name} to %{version} [nodoc]"

data/.gitignore

@@ -0,0 +1,9 @@
+# Also see https://github.com/github/gitignore/blob/master/Ruby.gitignore
+
+Gemfile.lock
+*.gem
+.bundle
+.env
+rdoc
+tmp
+.rspec_status

data/.rspec

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

data/.solargraph.yml

@@ -0,0 +1,14 @@
+---
+include:
+  - "**/*.rb"
+exclude:
+  - spec/**/*
+  - vendor/**/*
+  - ".bundle/**/*"
+require: []
+domains: []
+reporters:
+  - require_not_found
+require_paths: []
+plugins: []
+max_files: 5000

data/.standard.yml

@@ -0,0 +1,7 @@
+fix: true
+parallel: true
+format: progress
+ruby_version: 2.7.1
+ignore:
+  - "lib/**/*":
+      - Style/MissingRespondToMissing

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+## [v1.1.0](https://github.com/andrewmcodes/bridgetown-inline-svg/tree/v1.1.0) (2020-07-21)
+
+[Full Changelog](https://github.com/andrewmcodes/bridgetown-inline-svg/compare/v1.0.0...v1.1.0)
+
+**Merged pull requests:**
+
+- Update documentation [\#5](https://github.com/andrewmcodes/bridgetown-inline-svg/pull/5) ([andrewmcodes](https://github.com/andrewmcodes))
+- bug: Allow svg in partial without passing "site: site" explicitly [\#4](https://github.com/andrewmcodes/bridgetown-inline-svg/pull/4) ([MikeRogers0](https://github.com/MikeRogers0))
+
+## [v1.0.0](https://github.com/andrewmcodes/bridgetown-inline-svg/tree/v1.0.0) (2020-07-11)
+
+[Full Changelog](https://github.com/andrewmcodes/bridgetown-inline-svg/compare/dcf77a73d7fee38fdc00dfce3b6a7f50ebd27636...v1.0.0)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

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 andrewmcodes@protonmail.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,19 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 13.0"
+end
+
+group :development do
+  gem "solargraph", "~> 0.39"
+  gem "standard", "~> 0.4"
+end
+
+group :test do
+  gem "coveralls", "~> 0.8.23"
+  gem "rspec", "~> 3.0"
+  gem "simplecov", "~> 0.16.1"
+  gem "webmock", "~> 3.0"
+end

data/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT LICENSE
+
+Copyright (c) 2020 Andrew Mason <andrewmcodes@protonmail.com>
+
+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,77 @@
+<div align="center">
+  <h1>ForemLite</h1>
+  <p>
+    <a href="LICENSE" target="_blank">
+      <img alt="License: MIT" src="https://img.shields.io/github/license/andrewmcodes/forem_lite" />
+    </a>
+    <a href="https://badge.fury.io/rb/forem_lite"><img src="https://badge.fury.io/rb/forem_lite.svg" alt="Gem Version" height="18"></a>
+    <a href="https://depfu.com"><img src="https://badges.depfu.com/badges/9cf174e17d58cbd60ea040722701e652/status.svg" alt="Depfu"></a>
+    <a href="https://depfu.com/github/andrewmcodes/forem_lite?project_id=14214"><img src="https://badges.depfu.com/badges/9cf174e17d58cbd60ea040722701e652/count.svg" alt="Depfu"></a>
+    <a href="https://codeclimate.com/github/andrewmcodes/forem_lite/maintainability"><img src="https://api.codeclimate.com/v1/badges/999e4e19ff915c1d4c8a/maintainability" /></a>
+    <a href="https://www.codacy.com/manual/andrewmcodes/forem_lite?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=andrewmcodes/forem_lite&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/4954986dea2e4732add795399a3c8c9d"/></a>
+    <a href='https://coveralls.io/github/andrewmcodes/forem_lite?branch=main'><img src='https://coveralls.io/repos/github/andrewmcodes/forem_lite/badge.svg?branch=main' alt='Coverage Status' /></a>
+    <img alt="inch ci" src="http://inch-ci.org/github/andrewmcodes/forem_lite.svg?branch=main&style=shields">
+    <img alt="Tests" src="https://github.com/andrewmcodes/forem_lite/workflows/Tests/badge.svg" />
+    <img alt="Linters" src="https://github.com/andrewmcodes/forem_lite/workflows/Linters/badge.svg" />
+    <img alt="Changelog" src="https://github.com/andrewmcodes/forem_lite/workflows/Changelog/badge.svg" />
+  </p>
+</div>
+
+A simple tool to help you get articles from Forem/Dev.to.
+
+The patterns laid out in this gem could easily be used to finish building out the rest of the API, but I only needed articles so I am leaving the rest up to contributors or for when I eventually need to use it as well.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "forem_lite"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install forem_lite
+```
+
+## Usage
+
+```rb
+require "forem_lite"
+
+c = ForemLite::Client.new
+
+# https://docs.dev.to/api/#operation/getArticles
+articles = c.articles
+articles.first.title # => "How do you keep notes?"
+
+# https://docs.dev.to/api/#operation/getArticleById
+article = c.article(279134)
+article.title # => "A11Y in Rails: Automated Linting with AccessLint🎉"
+article.url # => "https://dev.to/andrewmcodes/a11y-in-rails-automated-linting-with-accesslint-1618"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/andrewmcodes/forem_liteent. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/andrewmcodes/forem_liteent/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DevApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andrewmcodes/forem_liteent/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -I lib -r forem_lite.rb"
+end

data/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+Security backports will be provided for some previous release series if needed.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.0.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+If you find a security issue with this gem, please open an issue, or contact [Andrew Mason](https://github.com/andrewmcodes) directly.

data/forem_lite.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/forem_lite/version"
+
+Gem::Specification.new do |s|
+  s.name = "forem_lite"
+  s.version = ForemLite::VERSION
+  s.authors = ["Andrew Mason"]
+  s.email = ["andrewmcodes@protonmail.com"]
+  s.licenses = "MIT"
+  s.homepage = "https://github.com/andrewmcodes/forem_lite"
+
+  s.summary = "A minimal API wrapper to retrieve Forem articles."
+  s.description = s.summary
+  s.metadata = {
+    "bug_tracker_uri" => "#{s.homepage}/forem_lite/issues",
+    "changelog_uri" => "#{s.homepage}/blob/main/CHANGELOG.md",
+    "documentation_uri" => "#{s.homepage}/forem_lite",
+    "homepage_uri" => "#{s.homepage}/forem_lite",
+    "source_code_uri" => "#{s.homepage}/forem_lite"
+  }
+
+  # 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.
+  s.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec|bin|tmp|.github)/}) }
+  end
+
+  s.require_paths = ["lib"]
+
+  s.add_dependency "httparty", "~> 0.18.1"
+  s.add_dependency "zeitwerk", "< 3.0"
+end

data/lib/forem_lite.rb

@@ -0,0 +1,9 @@
+require "httparty"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module ForemLite
+  class Error < StandardError; end
+end

data/lib/forem_lite/article.rb

@@ -0,0 +1,47 @@
+module ForemLite
+  class Article
+    attr_accessor :raw
+
+    #
+    # Article Initializer
+    #
+    # @param [Hash] options <the article attributes returned by Forem>
+    #
+    def initialize(options)
+      @raw = options
+    end
+
+    #
+    # Intercept NoMethodError exceptions and handle gracefully.
+    #
+    # @param [Symbol] method_sym <symbolized name of the method being called>
+    # @param [Hash] *arguments <the arguments passed in to this method. Can be any number, or none>
+    # @param [Object] &block <the block of the method called>
+    #
+    # @return [String, Object] the method return value or NoMethodError
+    #
+    def method_missing(method_sym, *arguments, &block)
+      if @raw&.keys&.include?(method_sym.to_s)
+        @raw[method_sym.to_s]
+      else
+        super
+      end
+    end
+
+    #
+    # Hook method to return whether the obj can respond to id method or not.
+    #
+    # @param [Symbol] method_sym <symbolized name of the method being called>
+    # @param [Boolean] include_private <indicates whether to include private methods in the search scope>
+    #
+    # @return [Boolean, Object] <returns true if we can respond to the method, otherwise NoMethodError>
+    #
+    def respond_to?(method_sym, include_private = false)
+      if @raw&.keys&.include?(method_sym.to_s)
+        true
+      else
+        super
+      end
+    end
+  end
+end

data/lib/forem_lite/client.rb

@@ -0,0 +1,35 @@
+module ForemLite
+  class Client
+    include HTTParty
+    base_uri "https://dev.to/api/"
+
+    #
+    # Create a new client object with your Forem API key.
+    #
+    # @param [String] api_key <Forem/Dev.to API Key>
+    #
+    def initialize(api_key = nil)
+      self.class.default_options[:headers] = {"api-key" => api_key} if api_key
+    end
+
+    #
+    # Retrieve a list of articles.
+    #
+    # @return [Array<Object>] collection of ForemLite::Article objects
+    #
+    def articles
+      self.class.get("/articles").tap { |z| ForemLite::Article.new(z) }
+    end
+
+    #
+    # Retrieve a single published article given its id.
+    #
+    # @param [Integer, String] id <a string or integer representing the article id>
+    #
+    # @return [Object] a FormCli::Article object
+    #
+    def article(id)
+      ForemLite::Article.new(self.class.get("/articles/#{id}"))
+    end
+  end
+end

data/lib/forem_lite/version.rb

@@ -0,0 +1,3 @@
+module ForemLite
+  VERSION = "0.0.2"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: forem_lite
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Andrew Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A minimal API wrapper to retrieve Forem articles.
+email:
+- andrewmcodes@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gem_release.yml"
+- ".gitignore"
+- ".rspec"
+- ".solargraph.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- SECURITY.md
+- forem_lite.gemspec
+- lib/forem_lite.rb
+- lib/forem_lite/article.rb
+- lib/forem_lite/client.rb
+- lib/forem_lite/version.rb
+homepage: https://github.com/andrewmcodes/forem_lite
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/andrewmcodes/forem_lite/forem_lite/issues
+  changelog_uri: https://github.com/andrewmcodes/forem_lite/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/andrewmcodes/forem_lite/forem_lite
+  homepage_uri: https://github.com/andrewmcodes/forem_lite/forem_lite
+  source_code_uri: https://github.com/andrewmcodes/forem_lite/forem_lite
+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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A minimal API wrapper to retrieve Forem articles.
+test_files: []