truemail-client 0.1.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed0062cf7b8d5dffcda7197b78c35693e0e3c6fc35e69c01948de4a8bf2e4df8
-  data.tar.gz: c5f1c8249883336d12c4c0c9248f9fb3725a055333b2f5bde49fa86180439e56
+  metadata.gz: d66b2f543cf4acf6562c363f578aaba256ce6b99192fbe46b0f5fb36514fea63
+  data.tar.gz: eaeb5cd3df955be353f7f1ca26df296e8d3762a29bdbc8cda7a9fddd3a3db334
 SHA512:
-  metadata.gz: f18bb396644f028cb9b2d269fe9bf44c52ff3378443d6b795b64939763736a3610467d40dd4b2365aef9d8bc2d94c0cd37993040e06ad14c447b97de2b75160c
-  data.tar.gz: 2de0b0b9a3f3efa114c3960c7adf221ac381304e5d38b744c604c1f8e9a68d023a9c9a143190f09a0f231befffd62c98874a93f626f9c588478864e4f21bcc9a
+  metadata.gz: 1f57b43e1a5439aa20da4423b08a4bf64975be817292e1022d26b3259c51c3b2ebc2762bbdabd5da11f91e247a77bb652590deb1d8ea538d0988013ee8927920
+  data.tar.gz: e026b94182d868f77b73c56af596799b6bbbf42a25a1c2aeb000af87ed8fe686a59f059daa6afe511b8406813aa425bcf1618a7351c8cfa7cb0e5babf9f21aae

data/.circleci/config.yml

@@ -1,11 +1,21 @@
+version: 2.1
+
 defaults: &defaults
   working_directory: ~/truemail-ruby-client
   docker:
-    - image: circleci/ruby:2.5.0-node
+    - image: cimg/ruby:<< parameters.ruby-version >>
   environment:
     CC_TEST_REPORTER_ID: 183d1173cc05e4e5dbd07ddb60a04b9c4115ed11a4bacda0e1834572eb168c51
 
+orbs:
+  ruby: circleci/ruby@1.1.3
+
 references:
+  install_bundler: &install_bundler
+    run:
+      name: Installing Bundler
+      command: gem i bundler -v $(tail -1 Gemfile.lock | tr -d ' ')
+
   restore_bundle_cache: &restore_bundle_cache
     restore_cache:
       keys:
@@ -24,66 +34,97 @@ references:
 
   install_codeclimate_reporter: &install_codeclimate_reporter
     run:
-      name: Install Code Climate Test Reporter
+      name: Installing CodeClimate test reporter
       command: |
             curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
             chmod +x ./cc-test-reporter
 
-version: 2
 jobs:
-  linters:
+  linters-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
     <<: *defaults
 
     steps:
       - checkout
 
+      - <<: *install_bundler
       - <<: *restore_bundle_cache
       - <<: *bundle_install
       - <<: *save_bundle_cache
 
       - run:
-          name: Running overcommit
+          name: Running Overcommit
           command: |
             bundle exec overcommit -s
             SKIP=AuthorEmail,AuthorName bundle exec overcommit -r
 
-  tests:
+  tests-ruby:
+    parameters:
+      ruby-version:
+        type: string
+
     <<: *defaults
 
     steps:
       - checkout
 
+      - <<: *install_bundler
       - <<: *restore_bundle_cache
       - <<: *bundle_install
       - <<: *save_bundle_cache
       - <<: *install_codeclimate_reporter
 
       - run:
-          name: Running tests
+          name: Running RSpec
           command: |
-            mkdir /tmp/test-results
             ./cc-test-reporter before-build
             bundle exec rspec
 
       - run:
-          name: Code Climate Test Coverage
+          name: Creating CodeClimate test coverage report
           command: |
             ./cc-test-reporter format-coverage -t simplecov -o "coverage/codeclimate.$CIRCLE_NODE_INDEX.json"
 
-      - store_test_results:
-          path: /tmp/test-results
-
       - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
+          name: Saving Simplecov coverage artifacts
+          path: ~/truemail-ruby-client/coverage
+          destination: coverage
 
       - deploy:
+          name: Uploading CodeClimate test coverage report
           command: |
             ./cc-test-reporter sum-coverage --output - --parts $CIRCLE_NODE_TOTAL coverage/codeclimate.*.json | ./cc-test-reporter upload-coverage --debug --input -
 
+  compatibility-ruby:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+    steps:
+      - checkout
+      - ruby/install-deps:
+          with-cache: false
+          path: './vendor/custom_bundle'
+      - run:
+          name: Running compatibility tests
+          command: bundle exec rspec
+
 workflows:
-  version: 2
-  build:
+  build_and_test:
     jobs:
-      - linters
-      - tests
+      - linters-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["2.5"]
+      - tests-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["2.5"]
+      - compatibility-ruby:
+          matrix:
+            parameters:
+              ruby-version: ["2.6", "2.7", "3.0"]

data/.codeclimate.yml

@@ -7,7 +7,7 @@ checks:
 plugins:
   rubocop:
     enabled: true
-    channel: rubocop-0-88
+    channel: rubocop-1-14
 
   reek:
     enabled: true

data/.github/BRANCH_NAMING_CONVENTION.md

@@ -0,0 +1,36 @@
+# Branch naming convention
+
+## Branch naming
+
+> Please note for new pull requests create new branches from current `develop` branch only.
+
+Branch name should include type of your contribution and context. Please follow next pattern for naming your branches:
+
+```bash
+feature/add-some-feature
+technical/some-technical-improvements
+bugfix/fix-some-bug-name
+```
+
+## Before PR actions
+
+### Squash commits
+
+Please squash all branch commits into the one before openning your PR from your fork. It's simple to do with the git:
+
+```bash
+git rebase -i [hash your first commit of your branch]~1
+git rebase -i 6467fe36232401fa740af067cfd8ac9ec932fed2~1 # example
+```
+
+### Add commit description
+
+Please complete your commit description folowing next pattern:
+
+```
+Technical/Add info files # should be the same name as your branch name
+
+* Added license, changelog, contributing, code of conduct docs
+* Added GitHub templates
+* Updated project license link
+```

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] Your bug report title here"
+labels: bug
+assignees: bestwebua
+
+---
+
+<!-- Thanks for helping to make Truemail better! Before submit your bug, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+
+### New bug checklist
+
+- [ ] I have updated `truemail-ruby-client` to the latest version
+- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-ruby-client/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://truemail-rb.org/truemail-ruby-client)
+- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-ruby-client/issues)
+
+<!-- Please use next pattern for your bug report title: [BUG] Your bug report title here -->
+
+### Bug description
+<!-- Please include what's happening, expected behavior, and any relevant code samples -->
+
+##### Complete output when running truemail, including the stack trace and command used
+
+<details>
+  <pre>[INSERT OUTPUT HERE]</pre>
+</details>

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,27 @@
+---
+name: Feature request
+about: Suggest an idea for Truemail
+title: "[FEATURE] Your feature request title here"
+labels: enhancement
+assignees: bestwebua
+
+---
+
+<!-- Thanks for helping to make Truemail better! Before submit your new feature request, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+
+### New feature request checklist
+
+- [ ] I have updated `truemail-ruby-client` to the latest version
+- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-ruby-client/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://truemail-rb.org/truemail-ruby-client)
+- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-ruby-client/issues)
+
+<!-- Please use next pattern for your feature request title: [FEATURE] Your feature request title here -->
+
+### Feature description
+
+<!-- Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+Describe the solution you'd like. A clear and concise description of what you want to happen.
+
+Describe alternatives you've considered. A clear and concise description of any alternative solutions or features you've considered. -->

data/.github/{ISSUE_TEMPLATE.md → ISSUE_TEMPLATE/issue_report.md}

@@ -1,13 +1,24 @@
+---
+name: Issue report
+about: Create a report to help us improve
+title: "[ISSUE] Your issue report title here"
+labels: ''
+assignees: bestwebua
+
+---
+
 <!-- Thanks for helping to make Truemail better! Before submit your issue, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
 
-### New Issue Checklist
+### New issue checklist
 
-- [ ] I have updated truemail-ruby-client to the latest version
+- [ ] I have updated `truemail-ruby-client` to the latest version
 - [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-ruby-client/blob/master/CONTRIBUTING.md)
-- [ ] I have read the [documentation](https://github.com/truemail-rb/truemail-ruby-client/blob/master/README.md)
+- [ ] I have read the [documentation](https://truemail-rb.org/truemail-ruby-client)
 - [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-ruby-client/issues)
 
-### Issue Description
+<!-- Please use next pattern for your issue report title: [ISSUE] Your issue report title here -->
+
+### Issue description
 <!-- Please include what's happening, expected behavior, and any relevant code samples -->
 
 ##### Complete output when running truemail, including the stack trace and command used

data/.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,22 @@
+---
+name: Question
+about: Ask your question to Truemail team
+title: "[QUESTION] Your question title here"
+labels: question
+assignees: bestwebua
+
+---
+
+<!-- Thanks for helping to make Truemail better! Before submit your question, please make sure to check the following boxes by putting an x in the [ ] (don't: [x ], [ x], do: [x]) -->
+
+### New question checklist
+
+- [ ] I have read the [Contribution Guidelines](https://github.com/truemail-rb/truemail-ruby-client/blob/master/CONTRIBUTING.md)
+- [ ] I have read the [documentation](https://truemail-rb.org/truemail-ruby-client)
+- [ ] I have searched for [existing GitHub issues](https://github.com/truemail-rb/truemail-ruby-client/issues)
+
+<!-- Please use next pattern for your question title: [QUESTION] Your question title here -->
+
+### Question
+
+<!-- Your question context here -->

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,9 @@
 # PR Details
 
 <!-- Provide a general summary of your changes in the Title above -->
+<!-- PR name should the same name as your branch name, example: -->
+<!-- Branch name is: feature/add-some-feature -->
+<!-- PR name should be: Feature/Add some feature -->
 
 ## Description
 

data/.rubocop.yml

@@ -22,6 +22,10 @@ Metrics/CyclomaticComplexity:
 Metrics/PerceivedComplexity:
   Enabled: false
 
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/truemail/client/http.rb'
+
 Naming/VariableNumber:
   Enabled: false
 
@@ -91,6 +95,46 @@ Style/RedundantRegexpEscape:
 Style/SlicingWithRange:
   Enabled: true
 
+Style/ArgumentsForwarding:
+  Enabled: true
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/EndlessMethod:
+  Enabled: true
+
+Style/HashConversion:
+  Enabled: true
+
+Style/HashExcept:
+  Enabled: true
+
+Style/IfWithBooleanLiteralBranches:
+  Enabled: true
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
+Style/RedundantArgument:
+  Enabled: true
+
+Style/StringChars:
+  Enabled: true
+
+Style/SwapValues:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/truemail/client/http.rb'
+
 Layout/LineLength:
   Max: 140
 
@@ -125,6 +169,9 @@ Layout/ClassStructure:
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
+Layout/SpaceBeforeBrackets:
+  Enabled: true
+
 Lint/NonDeterministicRequireOrder:
   Enabled: true
 
@@ -143,6 +190,54 @@ Lint/RaiseException:
 Lint/StructNewOverride:
   Enabled: true
 
+Lint/AmbiguousAssignment:
+  Enabled: true
+
+Lint/DeprecatedConstants:
+  Enabled: true
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: false
+
+Lint/NumberedParameterAssignment:
+  Enabled: true
+
+Lint/OrAssignmentToConstant:
+  Enabled: true
+
+Lint/RedundantDirGlobSort:
+  Enabled: true
+
+Lint/SymbolConversion:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/TripleQuotes:
+  Enabled: true
+
+Lint/UnexpectedBlockArity:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
 Performance/AncestorsInclude:
   Enabled: true
 
@@ -167,6 +262,33 @@ Performance/Squeeze:
 Performance/StringInclude:
   Enabled: true
 
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+
+Performance/ConstantRegexp:
+  Enabled: true
+
+Performance/MapCompact:
+  Enabled: true
+
+Performance/MethodObjectAsBlock:
+  Enabled: true
+
+Performance/RedundantEqualityComparisonBlock:
+  Enabled: true
+
+Performance/RedundantSplitRegexpArgument:
+  Enabled: true
+
+Performance/Sum:
+  Enabled: true
+
+Gemspec/DateAssignment:
+  Enabled: true
+
 RSpec/ExampleLength:
   Enabled: false
 
@@ -190,3 +312,9 @@ RSpec/MessageSpies:
 
 RSpec/MultipleDescribes:
   Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false
+
+RSpec/StubbedMock:
+  Enabled: false