mithraic_events 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db3b5d0600288d73eb9d87fa7e95fb8edd29e89fed0c32785af57d177174bad7
-  data.tar.gz: 31e280deb76a41862314fbf00dd9d808082acbbaa65f8e06db7f21ee9028536f
+  metadata.gz: d0010dd62bd2e4cd33ec6bd2a40b6a5a5c1322385c4b103d8533b51b83f6e050
+  data.tar.gz: 85c9005b1acfdbd5ae37e2d3b794aa06085053b49acd84dbf2019ec484e791b6
 SHA512:
-  metadata.gz: bd84fbea1e2b064b3e3f7350606320de4ff03d6cfb7347dda2efcc7b86837e86dea860c3737dbf9992c4b0a5546f91c365e7a9a34fedc4d6ec57f171eaa731db
-  data.tar.gz: e116896ce0f5f66451f658820cbc2c278c541b9191f2f9feae423987762872523fb6ecdad4627075805ac282cec28aed6606b9e49d6d3dc9299a389f904069d9
+  metadata.gz: d053fcb68a9d024d34ca4da7c27c16c621238689889755c16cc726cf063b8917b3347ef8c3aaf803786f16e2034072dea80db1ae306cb26f8b65ceb88329e230
+  data.tar.gz: 7ceebbe4c95c171ac1cd09877099f39329baa361b4b379ef93cef0208c7cc1f0a15aaa98e2cbb0c6c1b2b7fdb28a74d30783002704ad604f5c67b9403c4b0278

data/.rubocop.yml

@@ -1,13 +1,64 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  TargetRubyVersion: 2.6
+  # Exclude:
+  # TargetRubyVersion: 2.7
+  NewCops: enable
+  SuggestExtensions: false
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Metrics/MethodLength:
+  Max: 1000
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Metrics/ModuleLength:
+  Max: 1000
 
 Layout/LineLength:
-  Max: 120
+  Max: 5000
+
+Metrics/ClassLength:
+  Max: 2000
+
+Metrics/AbcSize:
+  Max: 200
+
+Metrics/BlockLength:
+  Max: 200
+
+Metrics/PerceivedComplexity:
+  Max: 100
+
+Metrics/CyclomaticComplexity:
+  Max: 30
+
+Style/NumericLiteralPrefix:
+  Enabled: false
+
+Style/GlobalVars:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 20
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RedundantInterpolation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/HashLikeCase:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/FloatComparison:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,56 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-06-17 23:34:55 UTC using RuboCop version 1.30.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    # - 'mithraic_events.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: strict, consistent
+Lint/SymbolConversion:
+  Exclude:
+    # - 'lib/mithraic_events.rb'
+
+# Offense count: 1
+Style/ClassVars:
+  Exclude:
+    # - 'lib/mithraic_events.rb'
+
+# Offense count: 4
+Style/OpenStructUse:
+  Exclude:
+    # - 'lib/plugin/plugin.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Methods.
+Style/RedundantArgument:
+  Exclude:
+    # - 'lib/plugin/plugin.rb'
+
+# Offense count: 85
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'bin/console'
+    # - 'lib/mithraic_events.rb'
+    - 'lib/mithraic_events/version.rb'
+    - 'lib/plugin/plugin.rb'
+    - 'mithraic_events.gemspec'
+    - 'spec/mithraic_events_spec.rb'
+    - 'spec/spec_helper.rb'

data/CHANGELOG.md

@@ -3,3 +3,8 @@
 ## [0.1.0] - 2022-06-11
 
 - Initial release
+
+## [0.1.1] - 2022-06-17
+- Add Documentation
+- Rubocop
+- Travis CI

data/Gemfile.lock

@@ -79,7 +79,7 @@ GEM
       nokogiri (~> 1)
       rake
     mini_mime (1.1.2)
-    minitest (5.15.0)
+    minitest (5.16.0)
     multi_xml (0.6.0)
     multipart-post (2.2.3)
     net-sftp (3.0.0)

data/README.md

@@ -1,37 +1,63 @@
-# MithraicEvents
+# Mithraic-Events
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mithraic_events`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Mithraic Events aims to provide a convenient and easy process for working with HTTParty and other facilities to help you in API testings.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add  Mithraic-Events to your `Gemfile`:
+
+```bash
+gem 'mithraic_events', '~> 0.1.1'
+```
+
+or
 
-    $ bundle add mithraic_events
+```ruby
+gem 'mithraic_events'
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Install:
 
-    $ gem install mithraic_events
+```bash
+bundle install
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+GET
+
+```bash
+get("#{url_token}members/me/?key={{api_key}}&token={{token}}"
+```
+
+POST
+
+```bash
+post("{url_token}boards/?name=comaed&key={{api_key}}&token={{token}}&defaultLists=false")
+```
 
-## Development
+PUT
 
-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.
+```bash
+put("{url_token}/cards/:id?idList={{doneListId}}&key={{trelloKey}}&token={{trelloToken}}")
+```
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+PATCH
+
+```bash
+patch("{url_token}/checklists/:id/:field?value=bottom")
+```
+
+DELETE
+
+```bash
+delete("{url_token}/boards/:id?key={{trelloKey}}&token={{trelloToken}}")
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mithraic_events. 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/[USERNAME]/mithraic_events/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/callyca/mithraic_events>. This project is intended to be a safe, welcoming space for collaboration.
 
 ## 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 MithraicEvents project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mithraic_events/blob/master/CODE_OF_CONDUCT.md).

data/lib/mithraic_events/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MithraicEvents
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/mithraic_events.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_relative "mithraic_events/version"
-require "httparty"
+require_relative 'mithraic_events/version'
+require 'httparty'
 
 module MithraicEvents
   include HTTParty
@@ -11,36 +11,36 @@ module MithraicEvents
   def get(url, query: nil, headers: nil, body: nil)
     headers = build_request(headers)
     response = HTTParty.get(url, query: query, headers: headers, body: body.to_json)
-    print_info("GET", url, query, headers, body, response) if ISPDF == "true"
+    print_info('GET', url, query, headers, body, response) if ISPDF == 'true'
     response
   end
 
   def post(url, query: nil, headers: nil, body: nil)
-    body = body.to_json unless body.eql?("grant_type=client_credentials")
+    body = body.to_json unless body.eql?('grant_type=client_credentials')
     headers = build_request(headers)
     response = HTTParty.post(url, query: query, headers: headers, body: body, timeout: 180)
-    print_info("POST", url, query, headers, body, response) if ISPDF == "true"
+    print_info('POST', url, query, headers, body, response) if ISPDF == 'true'
     response
   end
 
   def put(url, query: nil, headers: nil, body: nil)
     headers = build_request(headers)
     response = HTTParty.put(url, query: query, headers: headers, body: body.to_json)
-    print_info("PUT", url, query, headers, body, response) if ISPDF == "true"
+    print_info('PUT', url, query, headers, body, response) if ISPDF == 'true'
     response
   end
 
   def patch(url, query: nil, headers: nil, body: nil)
     headers = build_request(headers)
     response = HTTParty.patch(url, query: query, headers: headers, body: body.to_json)
-    print_info("PATCH", url, query, headers, body, response) if ISPDF == "true"
+    print_info('PATCH', url, query, headers, body, response) if ISPDF == 'true'
     response
   end
 
   def delete(url, query: nil, headers: nil, body: nil)
     headers = build_request(headers)
     response = HTTParty.delete(url, query: query, headers: headers, body: body.to_json)
-    print_info("DELETE", url, query, headers, body, response) if ISPDF == "true"
+    print_info('DELETE', url, query, headers, body, response) if ISPDF == 'true'
     response
   end
 
@@ -49,20 +49,20 @@ module MithraicEvents
   end
 
   def build_request(headers)
-    headers = { 'Content-Type': "application/json" } if headers.nil?
-    headers.merge!('Content-Type': "application/json") unless headers.key?(:'Content-Type')
-    headers.merge!('Authorization': @@token) unless defined?(@@token).nil?
+    headers = { 'Content-Type': 'application/json' } if headers.nil?
+    headers.merge!('Content-Type': 'application/json') unless headers.key?(:'Content-Type')
+    headers.merge!(Authorization: @@token) unless defined?(@@token).nil?
     headers
   end
 
   def print_info(verb, url, query, headers, body, response)
-    write_evidence("Request Method:", verb)
-    write_evidence("Request URL:", url)
-    write_evidence("Response Status:", response.code)
-    write_evidence("Query params:", query) unless query.nil?
-    write_evidence("Headers:", headers) unless headers.nil?
-    write_evidence("Request Body:", body) unless body.nil?
-    write_evidence("Response Body:", response.parsed_response) unless response.body.nil? || response.body.empty?
+    write_evidence('Request Method:', verb)
+    write_evidence('Request URL:', url)
+    write_evidence('Response Status:', response.code)
+    write_evidence('Query params:', query) unless query.nil?
+    write_evidence('Headers:', headers) unless headers.nil?
+    write_evidence('Request Body:', body) unless body.nil?
+    write_evidence('Response Body:', response.parsed_response) unless response.body.nil? || response.body.empty?
   end
 
   def write_evidence(text, value)
@@ -81,7 +81,7 @@ module MithraicEvents
   def prepare_mock_invalid(payload, field, max_length, character)
     json_navigate = field.split(/-/)
     object = JSON.parse(payload.to_json)
-    value = "".rjust(max_length.to_i, character)
+    value = ''.rjust(max_length.to_i, character)
     payload = set_value_iter(object, json_navigate, value)
     payload.to_h
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mithraic_events
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - callyca
@@ -248,7 +248,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Mithraic Event is a tool to help in the API testing with HTTParty
+description: Mithraic Events is a tool to help in the API testing with HTTParty
 email:
 - thiago.callyxz@gmail.com
 executables: []
@@ -257,6 +257,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -270,7 +271,8 @@ files:
 homepage: https://github.com/CallyCa/MithraicEvents
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: