trello_client_lite 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0e399125cb65919ae25688cf9a3c1ca27eb00fd6681c71a2585655b37f5c61c
+  data.tar.gz: 350f887da04a472c43879270cc5a1ec692f9085b7aa3f5c69242ef12c14b6bce
+SHA512:
+  metadata.gz: 7cd21758d4d126b6fd3698b2bbb9919e91f221702743dd7c1361812ce00d4a26c13eced3c45c45659a1df5d4df6c6c48abd62e8d830c11e54a3aaea66d8e1904
+  data.tar.gz: c86c68df7197e3248eea0d18868c2fe0af3303d9e75a5389cc11a09750c234778a418af282748da41c583d90082b4e765cb771422e11e3dc6b489986855f7a01

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trello_client_lite.gemspec
+gemspec
+
+# This group should never be installed
+group :never do
+  gem 'blank_gem'
+end

data/README.md

@@ -0,0 +1,149 @@
+# Trello Client
+
+A simple gem for interacting with basic endpoints of the Trello RestAPI
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trello_client_lite',
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install trello_client_lite
+```
+
+And require it:
+
+```ruby
+require 'trello_client_lite'
+```
+
+## Usage
+
+### Client
+
+For any interaction with the Trello API you'll need to new up a Trello Client.
+
+```ruby
+client = Trello::Client.new(
+   key: ENV.fetch('TRELLO_KEY'),
+   token: ENV.fetch('TRELLO_TOKEN')
+)
+```
+
+### Get Board by Name
+
+To get a board by name, use the client and pass in the name of the board you
+want to return.
+
+```ruby
+client.get_board_by_name(name: 'My Trello Board')
+```
+
+## Contributing
+
+This project has a few rules which applies to all contributions:
+
+1. All commits must follow the [Convention
+   Commits](https://www.conventionalcommits.org/) specification. This is less
+   scary than it sounds:
+   - It mostly involves adding a small prefix to each commit message that
+     indicates what type of commit it is. Common types are `feat:`, `fix:`,
+     `chore:`, `test:`, `docs:`, `refactor:`. See
+     [here](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)
+     for a complete list.
+   - A optional scope can also be provided. For example if adding a feature
+     within the "server" scope, the commit message prefix would be
+     `feat(server):`.
+   - Commits which introduce breaking changes MUST have a `!` before the `:` in
+     the commit message type prefix, or MUST format its main body as
+     `BREAKING CHANGE: <description>`. Ideally, do both for good measure.
+2. All changes must be added to `master` via Pull Requests.
+3. All Pull Requests must be merged by doing a fast-forward only merge. The
+   repository should already be setup to enforce this.
+
+Following these rules enables automatic version bumping and changelog
+generation, based on the commit history alone. And it also leads to a cleaner
+and more structured commit history overall, as each commit needs to fit into a
+specific type.
+
+## Development
+
+### Local Machine
+
+1. Ensure you have Ruby version 2.5.0 or later installed.
+2. Clone / checkout the repository.
+3. Run `bundle install` to install dependencies.
+4. Run `bundle exec rspec` to run test suite. Or alternatively, `make test` to
+   run the test suite in an isolated Docker environment.
+5. Run `bundle exec rubocop` to run linter. Or alternatively, `make lint` to run
+   the linter in an isolated Docker environment.
+6. Run `reek` to run another linter.... more details TODO
+7. Make changes.
+
+### Docker Environment
+
+1. Clone / checkout the repository.
+2. Ensure you have Docker installed with the `docker` CLI client in your `PATH`.
+3. Run `make shell` to get a `sh` shell within a Alpine-based Ruby container,
+   with `bundle install` already executed.
+4. Test suite and linter can be run within this environment with
+   `bundle exec rspec` and `bundle exec rubocop`, just like in the Local Machine
+   environment.
+5. Make changes.
+
+## Release
+
+Once enough changes have made it into `master` that it's worthy a of new
+release, it's time to bump the version.
+
+### Requirements
+
+- Node.js
+  - On macOS this can be installed with:
+
+```bash
+brew install node
+```
+
+- standard-version NPM package — Installed with:
+
+```bash
+npm install -g standard-version
+```
+
+### Cutting a Release
+
+1. From the `master` branch, create a new branch called `release`:
+   `git checkout -b release`
+2. Run: `make new-version` — Under the hood this runs `npx standard-version`,
+   which will:
+   - Read the current version from the `VERSION` file.
+   - Look at all commits since the most recent git tag to determine if those
+     changes yield a MAJOR, MINOR or PATCH change.
+   - Determine what the new version number is, and write said new version number
+     too the `VERSION` file.
+   - Update `CHANGELOG.md` with the new version, listing all `feat:` and `fix:`
+     commits as items changed since the previous version.
+   - Commit the changes to `VERSION` and `CHANGELOG.md` as a `chore(release):`
+     type commit.
+   - Create a git tag on the `chore(release):` commit matching the new version,
+     with a `v` prefix.
+3. Push the `release` branch, but not the git tag: `git push origin release`
+4. Open a Pull Request.
+5. When Pull Request has been approved, merge it WITHOUT deleting the branch.
+6. Run the release target for ruby gems `make release`
+7. Push the git tag: `git push origin v<VERSION>`
+8. Delete the `release` branch from the remote:
+   `git push origin --delete release`
+9. All done.

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/audit/task'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+Bundler::Audit::Task.new

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/trello.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'trello/version'
+require 'trello/exceptions'
+require 'trello/client'
+
+module Trello
+end

data/lib/trello/client.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+module Trello
+  class Client
+    def initialize(key:, token:)
+      @key = key
+      @token = token
+      @base_url = 'https://api.trello.com/1'
+    end
+
+    def get_board_by_name(name:)
+      boards.select { |value| value['name'] == name }.first
+    end
+
+    private
+
+    def request(endpoint)
+      url = "#{@base_url}/#{endpoint}"
+      response = yield(url)
+
+      return JSON.parse(response.body) if response.code.eql?(200)
+
+      raise_request_error(response)
+    end
+
+    def raise_request_error(response)
+      raise Trello::Exceptions::RequestError.new(
+        message: response.body,
+        http_code: response.code
+      )
+    end
+
+    def boards
+      options = { query: { key: @key, token: @token } }
+
+      request('members/me/boards') { |url| HTTParty.get(url, options) }
+    end
+  end
+end

data/lib/trello/exceptions.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Trello
+  module Exceptions
+    class RequestError < StandardError
+      def initialize(message:, http_code:)
+        message = "#{http_code}: #{message}"
+        super(message)
+      end
+    end
+  end
+end

data/lib/trello/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Trello
+  VERSION = File.read(
+    File.expand_path(File.join('..', '..', 'VERSION'), __dir__)
+  ).strip
+end

metadata

@@ -0,0 +1,246 @@
+--- !ruby/object:Gem::Specification
+name: trello_client_lite
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charlie Campbell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.78'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.78'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.38.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+- !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
+description: Client gem for Trello API
+email:
+- charlie.campbell14@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- lib/trello.rb
+- lib/trello/client.rb
+- lib/trello/exceptions.rb
+- lib/trello/version.rb
+homepage: https://gitlab.com/charlescampbell1/trello_client
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.com/charlescampbell1/trello_client
+  source_code_uri: https://gitlab.com/charlescampbell1/trello_client
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.1
+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: Client gem for Trello API
+test_files: []