api_client_builder 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61488aa64b23c4e971039af08754ac43a70277fe13cdb14ec5cc95cdc2cb4c1a
-  data.tar.gz: 1a14eaed9a3b913023c76e7b9788a3f8f39dea98749d299283eb5fe11d2a9d96
+  metadata.gz: f59cebf79d7809c5aaefdf60a84a0d3bd7d797c5bcb17d00d3cfd4c27af7aa6c
+  data.tar.gz: b23e9d509dcb617b8beb41dee7fb499f0dfa8e9bdd4f802b4cde713fd1abb724
 SHA512:
-  metadata.gz: 6b0431c58dff83f80caffcd891a7b984982143cc829403b1b49b97889570a452ea6df1d3b216fc1d2d76e68599d2ba1f3add4101eaca2402727e3d9ddbb274ec
-  data.tar.gz: b717e8415fc64ffbe9de0eb2c8086c282d87b943577e1e4d5bf6e84b620594ad6de9b3ac0e89a6ac3e79c570ff4cd72d08be854ffa8dc4d819ca843d4b17be42
+  metadata.gz: 2bb885f59496c7ff2a11ccdced0a31ff182cd8758ee420c14c3ed78cb3445d0f76b290fe0ee08dcb5f5bef945b3d4a98a04df5f749d7491abcc91d939551ba03
+  data.tar.gz: 00d6a87b521d7dfa9e3e0d92e2ee573d9c73c85b57f37cc9511a0b71467efb09754525a8dff2961171edc82f23414db426b17639c5e442d348c956f9608b46c5

data/Dockerfile

@@ -0,0 +1,18 @@
+FROM instructure/ruby-passenger:2.7
+
+ENV RAILS_ENV "production"
+
+USER root
+
+RUN apt-get update -qq \
+  && apt-get install -qqy \
+       git \
+  && rm -rf /var/lib/apt/lists/*
+
+USER docker
+
+COPY --chown=docker:docker . .
+
+RUN bundle install --jobs 8
+
+CMD ["tail", "-f", "/dev/null"]

data/Jenkinsfile

@@ -3,11 +3,59 @@ pipeline {
     label 'docker'
   }
 
+  options {
+    parallelsAlwaysFailFast()
+  }
+
   stages {
-    stage('Lint & Test') {
+    stage('Build') {
+      steps {
+        sh 'docker compose build --pull'
+      }
+    }
+
+    stage('Spec') {
+      steps {
+        sh 'docker compose run api_client_builder bundle exec rspec --format doc'
+        sh '''
+        image=$(docker ps --all --no-trunc | grep spec | cut -f 1 -d " " | head -n 1)
+        docker cp "$image:/usr/src/app/coverage" .
+        '''
+        sh 'ls -als coverage'
+      }
+
+      post {
+        always {
+          publishHTML target: [
+              allowMissing: false,
+              alwaysLinkToLastBuild: false,
+              keepAll: true,
+              reportDir: 'coverage',
+              reportFiles: 'index.html',
+              reportName: 'Coverage Report'
+            ]
+        }
+      }
+    }
+
+    stage('Publish') {
+      when {
+        allOf {
+          expression { GERRIT_BRANCH == 'master' }
+          environment name: 'GERRIT_EVENT_TYPE', value: 'change-merged'
+        }
+      }
       steps {
-        sh './build.sh'
+        withCredentials([string(credentialsId: 'rubygems-rw', variable: 'GEM_HOST_API_KEY')]) {
+          sh 'docker compose run -e GEM_HOST_API_KEY --rm api_client_builder /bin/bash -lc "./bin/publish.sh"'
+        }
       }
     }
   }
+
+  post {
+    cleanup {
+      sh 'docker compose down --rmi=all --volumes --remove-orphans'
+    }
+  }
 }

data/README.md

@@ -396,6 +396,31 @@ end
 
 response_body = single_request.response
 ```
+## Development
+First copy the compose override example file:
+```
+cp docker-compose.override.yml.example docker-compose.override.yml
+```
+
+This project uses [Compose watch](https://docs.docker.com/compose/file-watch/) to sync files between host and container.
+
+Compose watch will also rebuild the container (and install gems)
+if new dependencies are added to the gemspec.
+
+To build the container and start file watching, run the following
+```
+docker compose watch
+```
+
+To execute tests run
+```
+docker compose exec api_client_builder rspec
+```
+
+Start a shell in the container with
+```
+docker compose exec api_client_builder bash
+```
 
 ---
 

data/api_client_builder.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = 'https://github.com/instructure/api-client-builder'
 
   gem.version       = APIClientBuilder::VERSION
-  gem.required_ruby_version = '>= 2.3'
+  gem.required_ruby_version = '>= 2.7'
 
   gem.license = 'MIT'
 

data/bin/publish.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+current_version=$(ruby -e "require '$(pwd)/lib/api_client_builder/version.rb'; puts APIClientBuilder::VERSION;")
+
+if gem list --exact api_client_builder --remote --all | grep -o '\((.*)\)$' | tr '() ,'  '\n' | grep -xF "$current_version"; then
+  echo "Gem has already been published ... skipping ..."
+else
+  gem build ./api_client_builder.gemspec
+  find api_client_builder-*.gem | xargs gem push
+fi

data/docker-compose.override.yml.example

@@ -0,0 +1,14 @@
+version: '3.8'
+
+services:
+  api_client_builder:
+    develop:
+      watch:
+        - action: sync
+          path: ./
+          target: /usr/src/app
+          ignore:
+            - coverage
+            - .git
+        - action: rebuild
+          path: api_client_builder.gemspec

data/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '3.8'
+
+volumes:
+  bundler-config:
+  bundler-gems:
+
+services:
+  api_client_builder:
+    build:
+      context: .
+    volumes:
+      - bundler-config:/home/docker/.bundle
+      - bundler-gems:/home/docker/.gem/ruby

data/lib/api_client_builder/url_generator.rb

@@ -21,17 +21,26 @@ module APIClientBuilder
     #
     # @return [URI] the fully built route
     def build_route(route, **params)
-      string_params = route.split(%r{[\/=]}).select { |param| param.start_with?(':') }
+      string_params = route.split(%r{[\/=&]}).select { |param| param.start_with?(':') }
       symboled_params = string_params.map { |param| param.tr(':', '').to_sym }
 
       new_route = route.clone
       symboled_params.each do |param|
         value = params[param]
         raise ArgumentError, "Param :#{param} is required" unless value
-        new_route.gsub!(":#{param}", CGI.escape(value.to_s))
+        new_route.gsub!(":#{param}", encode_ascii(value.to_s))
       end
 
       @base_uri.merge(new_route)
     end
+
+    private
+
+    def encode_ascii(str)
+      str.each_char.map do |c|
+        next c if c.force_encoding('ascii').valid_encoding?
+        CGI.escape c
+      end.join
+    end
   end
 end

data/lib/api_client_builder/version.rb

@@ -1,3 +1,3 @@
 module APIClientBuilder
-  VERSION = '1.4.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/spec/lib/api_client_builder/url_generator_spec.rb

@@ -31,11 +31,34 @@ module APIClientBuilder
           url_generator = URLGenerator.new('https://www.domain.com/api/endpoints/')
 
           route = url_generator.build_route(
-            'route_to_object/:object_id/object',
-            object_id: "\u1F4a9"
+            'route_to_object/:object_id/object/:query_string',
+            object_id: "\u1F4a9",
+            query_string: "?sample[]=\u1F648\u1F649\u1F64A&success=party\u1F64C"
           )
-          expect(route).to eq(URI.parse('https://www.domain.com/api/endpoints/route_to_object/%E1%BD%8A9/object'))
+          expect(route).to eq(URI.parse('https://www.domain.com/api/endpoints/route_to_object/%E1%BD%8A9/object/' \
+                                        '?sample[]=%E1%BD%A48%E1%BD%A49%E1%BD%A4A&success=party%E1%BD%A4C'))
         end
+
+        context "and the route has multiple colon params in they query string" do
+          let(:url) { 'object_one/:object_one_id/:object_one_id/object&as_user_id=:user_object_id&param_2=:param_2&per_page=100' }
+          let(:url_generator) { URLGenerator.new('https://www.domain.com/api/endpoints/') }
+
+          subject do
+            route = url_generator.build_route(
+              url,
+              object_one_id: '4',
+              user_object_id: '1',
+              param_2: 'anotherqueryparam'
+            )
+          end
+
+          it do
+            is_expected.to eq URI.parse(
+              'https://www.domain.com/api/endpoints/object_one/4/4/object&as_user_id=1&param_2=anotherqueryparam&per_page=100'
+            )
+          end
+        end
+
       end
 
       context 'route with colon params and non matching keys' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_client_builder
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Jayce Higgins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -71,19 +71,23 @@ description: API Client Builder provides an easy to use interface for creating H
 email:
 - jhiggins@instructure.com
 - eng@instructure.com
-executables: []
+executables:
+- publish.sh
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
 - Jenkinsfile
 - LICENSE.txt
 - README.md
 - api_client_builder.gemspec
-- build.sh
+- bin/publish.sh
+- docker-compose.override.yml.example
+- docker-compose.yml
 - lib/api_client_builder.rb
 - lib/api_client_builder/api_client.rb
 - lib/api_client_builder/delete_request.rb
@@ -120,14 +124,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.6
 signing_key: 
 specification_version: 4
 summary: API Client Builder provides an easy to use interface for creating HTTP api

data/build.sh

@@ -1,16 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-
-docker pull ruby:2.5
-docker pull ruby:2.6
-
-docker run --rm -v "`pwd`:/app" -w /app --user `id -u`:`id -g` -e HOME="/tmp" "ruby:2.3" \
-  /bin/sh -c "echo \"gem: --no-document\" >> ~/.gemrc && bundle install --jobs 5 --quiet && bundle exec rubocop --cache false --fail-level autocorrect"
-
-for version in '2.5' '2.6'; do
-  echo "Testing Ruby $version..."
-  docker run --rm -v "`pwd`:/app" -w /app --user `id -u`:`id -g` \
-    -e HOME="/tmp" "ruby:$version" /bin/sh -c \
-    "echo \"gem: --no-document\" >> ~/.gemrc && bundle install --jobs 5 --quiet && bundle exec rspec"
-done