wcc-api 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49899b2b757d3a8867d8cab417abe229485607ce
-  data.tar.gz: 6dc8fd8bc6b4e698ff55b815be2433ed47f93f63
+  metadata.gz: 8b9ffb1ca9873f835817d010c263b3119ebd9d7f
+  data.tar.gz: b9c2eb273451c15f9448852e4aba17ae6482cd65
 SHA512:
-  metadata.gz: 38b967edc48dbc84cbf5de4e192308ed92fc0a57c607735ee9e773b3e63d66b13401be53fbebbc5d0f13f6aeaff8dfe7d64e89b46e96d2242d88c1ce4cb67178
-  data.tar.gz: 9b2a844b784e8cc7cb6c80d72cc6917b486933514a2fad24898c6103f2d2c2cddfb3f41ad739c0906b79b236e1bc6f0b50a9d4133c2504fbaed596a79594d67a
+  metadata.gz: 3363843ade51012c9619dc76949268190b76bce8d8cb4b684034e1bb222c39f589e91f2d27786354c6794baeda43a3cc480ab6d9e02dd0366412c984397af503
+  data.tar.gz: 3d48bb1a95ba2b631d3f976f07f74dfaf47909417570e1be8ce489b06bd83279043fef88204b1f18b163ecbf38483462ae08eb196f31ae4ceaf18f6fa8e3a8dd

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/IndentFirstHashElement:
+  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/Guardfile

@@ -0,0 +1,32 @@
+directories %w[lib spec]
+
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: 'bundle exec rspec --order rand', all_on_start: false do
+    require 'guard/rspec/dsl'
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+  end
+
+  guard :rubocop, cli: ['--display-cop-names'] do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+group :autofix do
+  guard :rubocop, all_on_start: false, cli: ['--auto-correct', '--display-cop-names'] do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+scope group: :red_green_refactor

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,17 +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/active_record_shim.rb

@@ -0,0 +1,69 @@
+module WCC::API::ActiveRecordShim
+  def self.included(base)
+    base.public_send :include, InstanceMethods
+    base.extend ClassMethods
+  end
+
+  module InstanceMethods
+    def attributes
+      raw.keys.each_with_object({}) do |key, h|
+        next unless respond_to?(key)
+
+        val = public_send(key)
+        h[key] =
+          if val.is_a? Array
+            val.map { |v| v.respond_to?(:to_h) ? v.to_h : v }
+          else
+            val.respond_to?(:to_h) ? val.to_h : val
+          end
+      end
+    end
+  end
+
+  module ClassMethods
+    def find(id)
+      client.public_send(endpoint).find(id)
+    end
+
+    def find_all(**filters)
+      client.public_send(endpoint).list(filters)
+    end
+
+    def find_by(**filters)
+      raise ArgumentError, "You must provide at least one filter" if filters.empty?
+
+      find_all(filters).first
+    end
+
+    def model_name
+      name
+    end
+
+    def table_name
+      endpoint
+    end
+
+    def unscoped
+      yield
+    end
+
+    def find_in_batches(options, &block)
+      options = options ? options.dup : {}
+      batch_size = options.delete(:batch_size) || 1000
+      skip_param = [:skip, :offset]
+
+      filter = {
+        limit: batch_size,
+        offset: options.delete(:start) || 0
+      }
+
+      find_all(filter).each_slice(batch_size, &block)
+    end
+
+    def where(**conditions)
+      # TODO: return a Query object that implements more of the ActiveRecord query interface
+      # https://guides.rubyonrails.org/active_record_querying.html#conditions
+      find_all(conditions)
+    end
+  end
+end