wcc-api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74231ceb352ccd172873342f6505b620cf239380
-  data.tar.gz: d4ecba5f2d57c5ed15b361362e11e4dca1c17906
+  metadata.gz: 29f4bd81d5f646565f0656931a8078216fb9de58
+  data.tar.gz: ae9b9f7df6dc2955fc353f71ddb6c245905e1b3b
 SHA512:
-  metadata.gz: 50d9e33f6592e94854cc838ae7f5de355ad90c53b961da4de8cd3d6d8c87636f0e8655404c5bb04ab7331b5ab196b1b6c51da998e11119905247eadadd694092
-  data.tar.gz: fa178778ec21bb489148291e23dabb36c5e49b7b6d4c044e2e4584f18e93d43c9106f0f4953faf9572e6416282d34456d028823fae53029d98e006cc5f3a019c
+  metadata.gz: d0561533a5a86c806a60a6ebfc4d99d8689775439a3f1eed22da10fdb62fa7e94eb73617a231920a6d97356b0cd119d26c02a66da2ab864caea1542540e14e95
+  data.tar.gz: 02e635a8449a312b0d1d7f974f91c84beedc5bd39cf62a7ad5bd253556bd4afedba949abbc064675340cbafade4f06652621d86847a8198bf3b1624889fd48a2

data/.circleci/config.yml

@@ -0,0 +1,41 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.3.3-node
+    steps:
+      - checkout
+      # Restore bundle cache
+      - restore_cache:
+          key: gem-{{ checksum "wcc-api.gemspec" }}
+
+      # copy env
+      - run: cp .env.example .env
+
+      # Bundle install dependencies
+      - run: bundle install --path /tmp/vendor/bundle
+
+      # Store bundle cache
+      - save_cache:
+          key: gem-{{ checksum "wcc-api.gemspec" }}
+          paths:
+            - /tmp/vendor/bundle
+
+      # run rubocop
+      - type: shell
+        command: |
+          bundle exec rubocop
+
+      # Run rspec in parallel
+      - type: shell
+        command: |
+          bundle exec rspec --profile 10 \
+                            --format RspecJunitFormatter \
+                            --out test_results/rspec.xml \
+                            --format documentation \
+                            --order rand \
+                            $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+
+      # Save test results for timing analysis
+      - store_test_results:
+          path: test_results

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,190 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+  Exclude:
+    # generated by rails/binstubs
+    - 'bin/**/*'
+
+    # generated by guard
+    - 'Guardfile'
+
+    # 3rd party
+    - 'vendor/**/*'
+    - 'lib/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    # we like the `let(:foo) {}` syntax in specs
+    - 'spec/**/*.rb'
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: compact
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    # spec files that might have a big describe
+    - 'spec/**/*.rb'
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+Layout/AlignHash:
+  # allow coder to get around alignment rules by explicitly defining the hash param
+  EnforcedLastArgumentHashStyle: ignore_explicit
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Rails:
+  Enabled: true
+
+  # These are all the cops that are disabled in the default configuration.
+
+Layout/FirstArrayElementLineBreak:
+  Description: >-
+                 Checks for a line break before the first element in a
+                 multi-line array.
+  Enabled: true
+
+Layout/FirstHashElementLineBreak:
+  Description: >-
+                 Checks for a line break before the first element in a
+                 multi-line hash.
+  Enabled: true
+
+Layout/FirstMethodArgumentLineBreak:
+  Description: >-
+                 Checks for a line break before the first argument in a
+                 multi-line method call.
+  Enabled: false
+
+Layout/FirstMethodParameterLineBreak:
+  Description: >-
+                 Checks for a line break before the first parameter in a
+                 multi-line method parameter definition.
+  Enabled: true
+
+Layout/MultilineAssignmentLayout:
+  Description: 'Check for a newline after the assignment operator in multi-line assignments.'
+  StyleGuide: '#indent-conditional-assignment'
+  Enabled: true
+
+Rails/SaveBang:
+  Description: 'Identifies possible cases where Active Record save! or related should be used.'
+  StyleGuide: 'https://github.com/bbatsov/rails-style-guide#save-bang'
+  Enabled: false
+
+Style/AutoResourceCleanup:
+  Description: 'Suggests the usage of an auto resource cleanup version of a method (if available).'
+  Enabled: true
+
+Style/CollectionMethods:
+  Description: 'Preferred collection methods.'
+  StyleGuide: '#map-find-select-reduce-size'
+  Enabled: true
+
+Style/Copyright:
+  Description: 'Include a copyright notice in each file before any code.'
+  Enabled: false
+
+Style/DocumentationMethod:
+  Description: 'Public methods.'
+  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+
+Style/ImplicitRuntimeError:
+  Description: >-
+                 Use `raise` or `fail` with an explicit exception class and
+                 message, rather than just a message.
+  Enabled: true
+
+Style/InlineComment:
+  Description: 'Avoid trailing inline comments.'
+  Enabled: true
+
+Style/MethodCallWithArgsParentheses:
+  Description: 'Use parentheses for method calls with arguments.'
+  StyleGuide: '#method-invocation-parens'
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Description: 'Avoid chaining a method call on a do...end block.'
+  StyleGuide: '#single-line-blocks'
+  # TODO: enable after fixing todos
+  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+
+Style/MissingElse:
+  Description: >-
+                Require if/case expressions to have an else branches.
+                If enabled, it is recommended that
+                Style/UnlessElse and Style/EmptyElse be enabled.
+                This will conflict with Style/EmptyElse if
+                Style/EmptyElse is configured to style "both"
+  Enabled: false
+  EnforcedStyle: both
+  SupportedStyles:
+    # if - warn when an if expression is missing an else branch
+    # case - warn when a case expression is missing an else branch
+    # both - warn when an if or case expression is missing an else branch
+    - if
+    - case
+    - both
+
+Style/OptionHash:
+  Description: "Don't use option hashes when you can use keyword arguments."
+  Enabled: true
+
+Style/ReturnNil:
+  Description: 'Use return instead of return nil.'
+  Enabled: true
+
+Style/Send:
+  Description: 'Prefer `Object#__send__` or `Object#public_send` to `send`, as `send` may overlap with existing methods.'
+  StyleGuide: '#prefer-public-send'
+  Enabled: true
+  Exclude:
+   - 'spec/**/*'
+
+Style/StringMethods:
+  Description: 'Checks if configured preferred methods are used over non-preferred.'
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Description: 'Enforces the names of some block params.'
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,63 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-02-11 12:22:05 -0600 using RuboCop version 0.64.0.
+# 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: 2
+Metrics/AbcSize:
+  Max: 56
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 31
+
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 25
+
+# Offense count: 2
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/wcc/api/json/pagination.rb'
+
+# Offense count: 5
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/wcc/api/railtie.rb'
+    - 'lib/wcc/api/rest_client/http_adapter.rb'
+    - 'lib/wcc/api/rest_client/typhoeus_adapter.rb'
+    - 'lib/wcc/api/version.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/IfUnlessModifier:
+  Exclude:
+    - 'lib/wcc/api/json/pagination.rb'
+
+# Offense count: 1
+# Configuration parameters: SuspiciousParamNames.
+# SuspiciousParamNames: options, opts, args, params, parameters
+Style/OptionHash:
+  Exclude:
+    - 'lib/wcc/api/controller_helpers.rb'
+
+# Offense count: 11
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 142

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in wcc-api.gemspec

data/Rakefile

@@ -1,2 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'

data/bin/rspec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/wcc/api.rb

@@ -1,18 +1,16 @@
+# frozen_string_literal: true
+
 require 'wcc'
 require 'wcc/api/version'
 
-module WCC
-  module API
-    PROJECT_ROOT = File.expand_path(File.join(__FILE__, '..', '..', '..'))
-  end
+module WCC::API
+  PROJECT_ROOT = File.expand_path(File.join(__FILE__, '..', '..', '..'))
 end
 
-if defined?(Rails)
-  require 'wcc/api/railtie'
-end
+require 'wcc/api/railtie' if defined?(Rails)
 
 require 'wcc/api/base_query'
 require 'wcc/api/json'
 require 'wcc/api/controller_helpers'
+require 'wcc/api/rest_client'
 require 'wcc/api/view_helpers'
-

data/lib/wcc/api/base_query.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module WCC::API
   class BaseQuery
-    attr_reader :scope, :paging
-    attr_accessor :limit, :offset
+    attr_reader :scope, :paging, :limit, :offset
     attr_accessor :filter
 
     MAX_LIMIT = 50
@@ -15,7 +16,7 @@ module WCC::API
     end
 
     def permitted_keys
-      %i(limit offset filter)
+      %i[limit offset filter]
     end
 
     def default_scope
@@ -27,11 +28,11 @@ module WCC::API
       @paging = paging
       set_defaults
       permitted_keys.each do |key|
-        self.public_send("#{key}=", params[key]) if params.has_key?(key)
+        public_send("#{key}=", params[key]) if params.key?(key)
       end
     end
 
-    def call(scope=self.scope)
+    def call(scope = self.scope)
       scope = scope.dup
       scope = paged(scope)
       scope = ordered(scope)
@@ -39,7 +40,7 @@ module WCC::API
       scope
     end
 
-    def paged(scope=self.scope)
+    def paged(scope = self.scope)
       if paging
         scope
           .limit(limit)
@@ -49,11 +50,11 @@ module WCC::API
       end
     end
 
-    def ordered(scope=self.scope)
+    def ordered(scope = self.scope)
       scope
     end
 
-    def filtered(scope=self.scope)
+    def filtered(scope = self.scope)
       scope
     end
 
@@ -65,7 +66,7 @@ module WCC::API
 
     def limit=(new_limit)
       new_limit = new_limit.to_i
-      @limit = (new_limit > MAX_LIMIT) ? MAX_LIMIT : new_limit
+      @limit = new_limit > MAX_LIMIT ? MAX_LIMIT : new_limit
     end
 
     def offset=(new_offset)
@@ -85,4 +86,3 @@ module WCC::API
     end
   end
 end
-

data/lib/wcc/api/controller_helpers.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 module WCC::API
   module ControllerHelpers
+    private
 
-    private def set_cache_headers(scope_or_record, options = {})
-      options = {public: true, must_revalidate: true}.merge!(options)
+    def set_cache_headers(scope_or_record, options = {})
+      options = { public: true, must_revalidate: true }.merge!(options)
 
       if expiry = options.delete(:expiry)
         expires_in expiry, options.slice(:public, :must_revalidate)
@@ -10,6 +13,5 @@ module WCC::API
 
       fresh_when scope_or_record, options.slice(:etag, :public, :last_modified)
     end
-
   end
 end