killbill-client 3.0.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ddae95b2a38eea5300104fce0e92606184bed34
-  data.tar.gz: 669f913923892eef204cb64ddff346dfe9fb76b2
+  metadata.gz: 03e77573407a78aef2165e380bc7e1d0f672b53d
+  data.tar.gz: 27e12ebd3c57f128cdd181c16e77e19d4be9daa5
 SHA512:
-  metadata.gz: 2c95bcc347ce08c76f84ab3a306227cc3829a3f5462a91f8738343e2d9ea01b868186c8e6f460ce1bc5e91b256b3caf8cf35f5bc94dd393f19a0e3d2c78c7ef4
-  data.tar.gz: cc831b9690d0e06d2b0b2ca0dcaacd19bb5f42bf4ca601b28215bec2379fccfe3197ca3ea7a533c20f491b7e1a3ee944560fbc47db316c6d190fef7dca5a6d3b
+  metadata.gz: 88715661ffaa19c983d3c0ba9a091cbd4c8cd9a242675de0e44a43c8d9cbf6aad172620a1902d545c6d6ec0964cf161bcb5793b7f69f7a2cb50cc8315db2994b
+  data.tar.gz: 5d199dffd09feffc3a02c83b9e886c29ba84c6d8317603146eff9e931d708cb69aed72c763b9ac5c38de46ac6632ad697c9c4ce94ceee83128fe2cfbdddf3ad1

data/.circleci/config.yml

@@ -5,90 +5,10 @@ defaults: &defaults
 
 version: 2
 jobs:
-  build-jruby-1.7.26:
-    <<: *defaults
-    docker:
-      - image: killbill/kbbuild:0.5.0
-    steps:
-      - checkout
-      - restore_cache:
-          key: v2-dependencies-jruby-1.7.26-{{ .Branch }}-{{ checksum "killbill_client.gemspec" }}
-      - run:
-          name: Install gem dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path=vendor/bundle
-      - save_cache:
-          paths:
-            - Gemfile.lock
-            - .bundle
-            - vendor/bundle
-          key: v2-dependencies-jruby-1.7.26-{{ .Branch }}-{{ checksum "killbill_client.gemspec" }}
-
-  test-mysql-jruby-1.7.26:
-    <<: *defaults
-    docker:
-      - image: killbill/kbbuild:0.5.0
-      - image: killbill/killbill:0.19.18
-      - image: killbill/mariadb:0.19
-        environment:
-        - MYSQL_ROOT_PASSWORD=root
-    steps:
-      - checkout
-      - restore_cache:
-          key: v2-dependencies-jruby-1.7.26-{{ .Branch }}-{{ checksum "killbill_client.gemspec" }}
-      - run:
-          name: Setup DDL
-          command: |
-            set +e
-            count=0
-            until mysqladmin ping -h 127.0.0.1 -u root --password=root --silent; do
-              if [[ "$count" == "25" ]]; then
-                exit 1
-              fi
-              (( count++ ))
-              printf '.'
-              sleep 5
-            done
-            set -e
-      - run:
-          name: Setup Kill Bill
-          command: |
-            set +e
-            count=0
-            until $(curl --output /dev/null --silent --fail http://127.0.0.1:8080/1.0/healthcheck); do
-              if [[ "$count" == "25" ]]; then
-                exit 1
-              fi
-              (( count++ ))
-
-              printf '.'
-              sleep 5
-            done
-            set -e
-            curl -v \
-                 -X POST \
-                 -u admin:password \
-                 -H 'Content-Type: application/json' \
-                 -H 'X-Killbill-CreatedBy: CircleCI' \
-                 -d '{"apiKey": "bob", "apiSecret": "lazar"}' \
-                 "http://127.0.0.1:8080/1.0/kb/tenants?useGlobalDefault=true"
-      - run:
-          name: Run tests
-          command: |
-            mkdir /tmp/test-results
-            bundle exec rspec --format documentation \
-                              --out /tmp/test-results/rspec.txt \
-                              $(circleci tests glob "spec/**/*_spec.rb")
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
-
   build-ruby-2.2.2:
     <<: *defaults
     docker:
-      - image: killbill/kbbuild:0.5.0
+      - image: killbill/kbbuild:0.6.0
     steps:
       - checkout
       - restore_cache:
@@ -109,9 +29,9 @@ jobs:
   test-mysql-ruby-2.2.2:
     <<: *defaults
     docker:
-      - image: killbill/kbbuild:0.5.0
-      - image: killbill/killbill:0.19.18
-      - image: killbill/mariadb:0.19
+      - image: killbill/kbbuild:0.6.0
+      - image: killbill/killbill:0.21.9
+      - image: killbill/mariadb:0.21
         environment:
         - MYSQL_ROOT_PASSWORD=root
     steps:
@@ -172,7 +92,7 @@ jobs:
   build-ruby-2.4.2:
     <<: *defaults
     docker:
-      - image: killbill/kbbuild:0.5.0
+      - image: killbill/kbbuild:0.6.0
     steps:
       - checkout
       - restore_cache:
@@ -193,9 +113,9 @@ jobs:
   test-mysql-ruby-2.4.2:
     <<: *defaults
     docker:
-      - image: killbill/kbbuild:0.5.0
-      - image: killbill/killbill:0.19.18
-      - image: killbill/mariadb:0.19
+      - image: killbill/kbbuild:0.6.0
+      - image: killbill/killbill:0.21.9
+      - image: killbill/mariadb:0.21
         environment:
         - MYSQL_ROOT_PASSWORD=root
     steps:
@@ -256,7 +176,7 @@ jobs:
   build-jruby-9.1.14.0:
     <<: *defaults
     docker:
-      - image: killbill/kbbuild:0.5.0
+      - image: killbill/kbbuild:0.6.0
     steps:
       - checkout
       - restore_cache:
@@ -277,9 +197,9 @@ jobs:
   test-mysql-jruby-9.1.14.0:
     <<: *defaults
     docker:
-      - image: killbill/kbbuild:0.5.0
-      - image: killbill/killbill:0.19.18
-      - image: killbill/mariadb:0.19
+      - image: killbill/kbbuild:0.6.0
+      - image: killbill/killbill:0.21.9
+      - image: killbill/mariadb:0.21
         environment:
         - MYSQL_ROOT_PASSWORD=root
     steps:
@@ -340,32 +260,18 @@ workflows:
   version: 2
   build-and-test:
     jobs:
-      # Kill Bill plugins
-      - build-jruby-1.7.26
       # Self-contained KPM
-      - build-ruby-2.2.2:
-          requires:
-            - build-jruby-1.7.26
+      - build-ruby-2.2.2
       # Kaui and other gems
-      - build-ruby-2.4.2:
-          requires:
-            - build-jruby-1.7.26
+      - build-ruby-2.4.2
       # Self-contained Kaui
-      - build-jruby-9.1.14.0:
-          requires:
-            - build-jruby-1.7.26
-      - test-mysql-jruby-1.7.26:
-          requires:
-            - build-jruby-1.7.26
+      - build-jruby-9.1.14.0
       - test-mysql-ruby-2.2.2:
           requires:
             - build-ruby-2.2.2
-            - test-mysql-jruby-1.7.26
       - test-mysql-ruby-2.4.2:
           requires:
             - build-ruby-2.4.2
-            - test-mysql-jruby-1.7.26
       - test-mysql-jruby-9.1.14.0:
           requires:
             - build-jruby-9.1.14.0
-            - test-mysql-jruby-1.7.26

data/.github/CONTRIBUTING.md

@@ -0,0 +1,20 @@
+## How to contribute to Kill Bill
+
+**Do not open up a GitHub issue before reaching out to our [Mailing-List](https://groups.google.com/forum/#!forum/killbilling-users)**. GitHub issues are primarily intended for tracking bug reports and fixes by the core team.
+
+#### **Did you find a bug?**
+
+In your [Mailing-List](https://groups.google.com/forum/#!forum/killbilling-users) post, specify:
+
+* Step by step description on how to reproduce the issue
+* [Account data and system dump](http://docs.killbill.io/0.19/debugging.html#_seeking_help) via KPM of an affected account
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+Do not open an issue or pull request on GitHub until you have collected positive feedback about the change on the [Mailing-List](https://groups.google.com/forum/#!forum/killbilling-users).
+
+When submitting code, make sure to add [new tests](http://docs.killbill.io/0.19/development.html#_navigating_the_kill_bill_codebase).
+
+#### **Do you want to contribute to the Kill Bill documentation?**
+
+Open a pull request on GitHub in the [killbill-docs](https://github.com/killbill/killbill-docs) repository.

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [killbill]

data/.github/workflows/ci.yml

@@ -0,0 +1,145 @@
+name: ci
+
+on:
+  push:
+  workflow_dispatch:
+
+env:
+  COMPOSE_DOCKER_CLI_BUILD: 1
+  DB_NAME: kaui
+  DOCKER_BUILDKIT: 1
+  JRUBY_OPTS: --2.0 -J-Xmx1024M
+  KB_ADDRESS: 127.0.0.1
+  KB_PORT: 8080
+  RAILS_ENV: test
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - ruby-version: '2.4.2'
+            database-adapter: 'mysql2'
+            database-user: 'root'
+            database-password: 'root'
+            database-port: '3306'
+            docker-compose-file: 'docker-compose.ci.mysql.yml'
+          - ruby-version: 'jruby-9.1.17.0'
+            database-adapter: 'mysql2'
+            database-user: 'root'
+            database-password: 'root'
+            database-port: '3306'
+            docker-compose-file: 'docker-compose.ci.mysql.yml'
+          - ruby-version: '2.4.2'
+            database-adapter: 'postgresql'
+            database-user: 'postgres'
+            database-password: 'postgres'
+            database-port: '5432'
+            docker-compose-file: 'docker-compose.ci.postgresql.yml'
+          - ruby-version: 'jruby-9.1.17.0'
+            database-adapter: 'postgresql'
+            database-user: 'postgres'
+            database-password: 'postgres'
+            database-port: '5432'
+            docker-compose-file: 'docker-compose.ci.postgresql.yml'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Start stack
+        run: |
+          cd docker
+          docker-compose -p it -f ${{ matrix.docker-compose-file }} up --no-start
+          docker start it_db_1
+      - name: Wait for MySQL
+        if: ${{ matrix.docker-compose-file == 'docker-compose.ci.mysql.yml' }}
+        run: |
+          set +e
+          count=0
+          until mysqladmin ping -h 127.0.0.1 -u root --password=root --silent; do
+            if [[ "$count" == "25" ]]; then
+              exit 1
+            fi
+            (( count++ ))
+            printf '.'
+            sleep 5
+          done
+          set -e
+      - name: Wait for PostgreSQL
+        if: ${{ matrix.docker-compose-file == 'docker-compose.ci.postgresql.yml' }}
+        run: |
+          set +e
+          count=0
+          until $(psql -h 127.0.0.1 -U postgres -p 5432 -l > /dev/null); do
+            if [[ "$count" == "25" ]]; then
+              exit 1
+            fi
+            (( count++ ))
+            printf '.'
+            sleep 5
+          done
+          set -e
+      - name: Start Kill Bill
+        # Sometimes it gets stuck (if Kill Bill starts when the DB isn't ready?)
+        timeout-minutes: 4
+        run: |
+          docker start it_killbill_1
+          count=0
+          until $(curl --connect-timeout 10 --max-time 30 --output /dev/null --silent --fail http://${KB_ADDRESS}:${KB_PORT}/1.0/healthcheck); do
+            if [[ "$count" == "180" ]]; then
+              exit 64
+            fi
+            count=$(( count + 1 ))
+            sleep 1
+          done
+          curl --connect-timeout 10 --max-time 30 -v \
+               -X POST \
+               -u admin:password \
+               -H 'Content-Type: application/json' \
+               -H 'X-Killbill-CreatedBy: GitHub' \
+               -d '{"apiKey": "bob", "apiSecret": "lazar"}' \
+               "http://${KB_ADDRESS}:${KB_PORT}/1.0/kb/tenants"
+      - name: Run fast tests
+        env:
+          DB_ADAPTER: ${{ matrix.database-adapter }}
+          DB_USER: ${{ matrix.database-user }}
+          DB_PASSWORD: ${{ matrix.database-password }}
+          DB_PORT: ${{ matrix.database-port }}
+        run: |
+          # Some flakiness unfortunately
+          ./bin/retry bundle exec rake test:spec
+      - name: Run remote tests
+        env:
+          DB_ADAPTER: ${{ matrix.database-adapter }}
+          DB_USER: ${{ matrix.database-user }}
+          DB_PASSWORD: ${{ matrix.database-password }}
+          DB_PORT: ${{ matrix.database-port }}
+        run: |
+          # Some flakiness unfortunately
+          ./bin/retry bundle exec rake test:remote:spec
+      - name: Debugging after failure
+        if: failure()
+        run: |
+          echo "[DEBUG] killbill healthcheck"
+          curl --connect-timeout 10 --max-time 30 -v http://${KB_ADDRESS}:${KB_PORT}/1.0/healthcheck || true
+          echo "[DEBUG] hostname"
+          hostname
+          echo "[DEBUG] netstat -tulpn"
+          sudo netstat -tulpn
+          echo "[DEBUG] docker network ls"
+          docker network ls
+          echo "[DEBUG] docker ps -a"
+          docker ps -a
+          echo "[DEBUG] killbill env"
+          docker exec it_killbill_1 env || true
+          echo "[DEBUG] db env"
+          docker exec it_db_1 env || true
+          echo "[DEBUG] killbill logs"
+          docker logs -t --details it_killbill_1 || true
+          echo "[DEBUG] db logs"
+          docker logs -t --details it_db_1 || true

data/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      target_version:
+        description: 'Target version: next [major|minor|patch|pre|release] or a given version number [x.x.x]'
+        required: true
+        default: 'patch'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup git user
+        env:
+          BUILD_USER: ${{ secrets.BUILD_USER }}
+          BUILD_TOKEN: ${{ secrets.BUILD_TOKEN }}
+        run: |
+          git config --global user.email "contact@killbill.io"
+          git config --global user.name "Kill Bill core team"
+          git config --global url."https://${BUILD_USER}:${BUILD_TOKEN}@github.com/".insteadOf "git@github.com:"
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.4.2'
+      - name: Download Ruby dependencies
+        run: |
+          bundle install
+      - name: Tag repository
+        run: |
+          bundle exec gem bump -c -p -t -v ${{ github.event.inputs.target_version }}
+      - name: Release Gem
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: |
+          mkdir -p ~/.gem
+          cat << EOF > ~/.gem/credentials
+          ---
+          :rubygems_api_key: ${RUBYGEMS_API_KEY}
+          EOF
+          chmod 0600 ~/.gem/credentials
+          bundle install
+          bundle exec gem release
+          rm -f ~/.gem/credentials

data/README.md

@@ -11,7 +11,7 @@ Kill Bill compatibility
 | 0.x.y          | 0.16.z            |
 | 1.x.y          | 0.18.z            |
 | 2.x.y          | 0.20.z            |
-| 3.x.y          | 0.21.z            |
+| 3.x.y          | 0.22.z            |
 
 Installation
 ------------
@@ -28,6 +28,37 @@ Alternatively, add the dependency in your Gemfile:
 gem 'killbill-client', '~> 1.0'
 ```
 
+Authentication
+--------------
+
+A username and password can be set directly in the `options` hash (accepted by each API method):
+```ruby
+options = {
+  :username => 'admin',
+  :password => 'password'
+}
+```
+These credentials are validated by Kill Bill either directly (users managed by Kill Bill) or via a third-party (LDAP, Okta, Auth0, etc.).
+
+Alternatively, a bearer token can be passed as such:
+```ruby
+options = {
+  :bearer => 'token'
+}
+```
+The security token would be validated by Kill bill via a third-party (e.g. Auth0).
+
+By default, Kill Bill won't maintain sessions, except when calling the API `/1.0/kb/security/permissions` (`JSESSIONID`, present in the `Set-Cookie` response header).
+This session id can be passed instead:
+```ruby
+options = {
+  :session_id => 'JSESSIONID'
+}
+```
+Using this session mechanism is recommend for user interfaces or to minimize the runtime dependency with a third-party provider.
+
+Note: if a timed out session is re-used (`last_access_time` older than 60 minutes by default), a `HTTP/1.1 401 Unauthorized` is returned with `Set-Cookie: JSESSIONID=deleteMe`, and the session is deleted from the database (and cache) on the server side.
+
 Examples
 --------