chartmogul-ruby 1.7.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 121298d0201238ec46cdc41e17f1ac76712b8f11a5e3b5dc584d2e87ab0eebbd
-  data.tar.gz: 2f14880133e609cd07c8ffa42cbc792e5bdd969adbb72eb0fd185fc157f670ef
+  metadata.gz: 33e208966c719bffc9d8d9d181e4644d65b46ec358874ecf2a81cfc1e8e048e6
+  data.tar.gz: 6cfac8ebad05c2f72de739dbf6658a08c19a49390690fb5cf606b8f7e30b7c92
 SHA512:
-  metadata.gz: 19d2d3f23a6388c7c466a54102d3187abe88f63b2e543080288c28a9b66aaa2ae97ee6fc5a348dd56b392c424fe8e634d577098ccf32af509c1e43378c2af210
-  data.tar.gz: 71cd95d2dd035e73923b44d5c09d1650367c16e1feb6edd217ad962ba6b3772819d5f0798b908d6e37793679572875ab6c802123bbce7a8360c010d99a1624f4
+  metadata.gz: b3a003808b751464816eae04ce90cfb84d131e3dca1542f2038399a6ed61e5cc1ab235342a563bce20ccfdfd66d2dd7a1f75d4e8dd52406c79acbf733ed5cc04
+  data.tar.gz: 9a1dbeb5328f677ffae281290c0fc278b82fdb86dfe05f3c562f8c509608b42fe717bd040361224e9eb1a82a01205674c49192d08945e2101521bbd58ad91dae

data/.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: Run specs and generate Code Climate report
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [2.3, 2.4, 2.5, 2.6, 2.7]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Set ENV for codeclimate (pull_request)
+        run: |
+          git fetch --no-tags --prune --depth=1 origin +refs/heads/$GITHUB_HEAD_REF:refs/remotes/origin/$GITHUB_HEAD_REF
+          echo "GIT_BRANCH=$GITHUB_HEAD_REF" >> $GITHUB_ENV
+          echo "GIT_COMMIT_SHA=$(git rev-parse origin/$GITHUB_HEAD_REF)" >> $GITHUB_ENV
+        if: github.event_name == 'pull_request'
+      - name: Set ENV for codeclimate (push)
+        run: |
+          echo "GIT_BRANCH=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
+          echo "GIT_COMMIT_SHA=$GITHUB_SHA" >> $GITHUB_ENV
+        if: github.event_name == 'push'
+      - name: Install Code Climate test report
+        run: |
+          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+          chmod +x ./cc-test-reporter
+          ./cc-test-reporter before-build
+      - name: Run tests
+        run: bundle exec rake
+      - name: Send Report to Code Climate
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        if: ${{ success() }}
+        run: ./cc-test-reporter after-build

data/2.0-Upgrade.md

@@ -0,0 +1,9 @@
+# Upgrading to chartmogul-ruby 2.0.0
+
+The gem upgrade brings breaking changes to the Metrics API. All other APIs remain unaffected. Please note the following changes:
+
+* If you used the Metrics API to get a customer's activities or subscriptions, make the following changes in the namespace
+  - `ChartMogul::Metrics::Activity.all('cus_58c7d166-3bd1-4c10-948e-e68bb0fa2478')` should be replaced with `ChartMogul::Metrics::Customers::Activity.all('cus_58c7d166-3bd1-4c10-948e-e68bb0fa2478')`
+  - `ChartMogul::Metrics::Subscription.all('cus_3f6f53d3-bca7-4fcd-ad47-345180ef329b')` should be replace with `ChartMogul::Metrics::Customers::Subscription.all('cus_3f6f53d3-bca7-4fcd-ad47-345180ef329b')`
+
+

data/README.md

@@ -8,7 +8,6 @@
 
 <p align="center">
   <a href="https://badge.fury.io/rb/chartmogul-ruby"><img src="https://badge.fury.io/rb/chartmogul-ruby.svg" alt="Gem Version"></a>
-  <a href="https://travis-ci.org/chartmogul/chartmogul-ruby"><img src="https://travis-ci.org/chartmogul/chartmogul-ruby.svg?branch=main" alt="Travis project"></a>
   <a href="https://codeclimate.com/github/chartmogul/chartmogul-ruby/test_coverage"><img src="https://api.codeclimate.com/v1/badges/40e8bdff4d1dbf2451de/test_coverage" /></a>
 </p>
 
@@ -53,13 +52,20 @@ This gem supports Ruby 2.3 and above.
 ## Configuration
 
 Configure `chartmogul-ruby` with your Account Token and Secret Key, available from the administration section of your ChartMogul account.
+You can either do this in the global scope for the whole runtime (eg. in initializer):
 
+```ruby
+ChartMogul.global_account_token = '<Account key goes here>'
+ChartMogul.global_secret_key = '<Secret key goes here>'
+```
+
+Or in a thread-safe scope for the current thread only (eg. different accounts in different async jobs):
 ```ruby
 ChartMogul.account_token = '<Account key goes here>'
 ChartMogul.secret_key = '<Secret key goes here>'
 ```
 
-Configuration is threadsafe and applied only to the current thread.
+Thread-safe configuration is used if available, otherwise global is used. 
 
 Test your authentication:
 ```ruby

data/changelog.md

@@ -1,5 +1,19 @@
 # chartmogul-ruby Change Log
 
+## Version 2.1.0 - 9 July 2021
+- Adds ChartMogul::Metrics::ActivitiesExport class to support async activities export endpoint
+
+## Version 2.0.0 - 25 June 2021
+- Moves customer scoped Metrics::Activities and Metrics::Subscriptions under Metrics::Customers namespace
+- Adds unscoped activities API endpoint
+
+## Version 1.7.2 - 16 March 2021
+- Fix bug preventing instantiating attributes on ChartMogul::Customers objects
+
+## Version 1.7.1 - 8 March 2021
+- Adds amount_in_cents to payment for partial payments
+- Adds account API endpoint
+
 ## Version 1.6.9 - 10 December 2020
 - Fix ChartMogul::Customers class
 

data/chartmogul-ruby.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables           = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths         = ['lib']
 
-  spec.add_dependency 'faraday', '~> 1.0.0'
+  spec.add_dependency 'faraday', '~> 1.0'
 
   spec.add_development_dependency 'bundler', '~> 2'
   spec.add_development_dependency 'pry', '~> 0.12.2'

data/fixtures/vcr_cassettes/ChartMogul_Customer/API_Interactions/correctly_interracts_with_the_API.yml

@@ -8,7 +8,7 @@ http_interactions:
       string: '{"name":"Customer Test Data Source"}'
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v1.0.1
       Content-Type:
       - application/json
       Authorization:
@@ -16,50 +16,38 @@ http_interactions:
   response:
     status:
       code: 201
-      message:
+      message: Created
     headers:
       server:
       - nginx/1.10.1
       date:
-      - Tue, 08 Nov 2016 08:57:33 GMT
+      - Tue, 16 Mar 2021 12:27:18 GMT
       content-type:
-      - application/json; charset=utf-8
+      - application/json
       transfer-encoding:
       - chunked
       connection:
-      - close
-      x-frame-options:
-      - SAMEORIGIN
-      x-xss-protection:
-      - 1; mode=block
-      x-content-type-options:
-      - nosniff
-      etag:
-      - W/"bcfee5f9180970835929930b05411ff4"
-      cache-control:
-      - max-age=0, private, must-revalidate
-      x-request-id:
-      - 9505cefe-9a7a-46af-a173-7a686cf46800
-      x-runtime:
-      - '0.461858'
-      strict-transport-security:
-      - max-age=15768000
+      - keep-alive
+      status:
+      - 201 Created
+      access-control-allow-credentials:
+      - 'true'
     body:
       encoding: UTF-8
-      string: '{"uuid":"ds_632433ee-a591-11e6-aa29-ff9ccc9a74aa","name":"Customer
-        Test Data Source","created_at":"2016-11-08T08:57:33.304Z","status":"never_imported"}'
+      string: '{"uuid":"ds_f2f67ad0-8652-11eb-a9f8-37471a677085","name":"Customer
+        Test Data Source","system":"Import API","created_at":"2021-03-16T12:27:18.630Z","status":"idle"}'
     http_version:
-  recorded_at: Tue, 08 Nov 2016 08:57:33 GMT
+  recorded_at: Tue, 16 Mar 2021 12:27:18 GMT
 - request:
     method: post
     uri: https://api.chartmogul.com/v1/customers
     body:
       encoding: UTF-8
-      string: '{"external_id":"X1234","name":"Test Customer","email":"test@example.com","country":"DE","city":"Berlin","data_source_uuid":"ds_632433ee-a591-11e6-aa29-ff9ccc9a74aa","lead_created_at":"2016-10-01
+      string: '{"external_id":"X1234","name":"Test Customer","email":"test@example.com","country":"DE","city":"Berlin","data_source_uuid":"ds_f2f67ad0-8652-11eb-a9f8-37471a677085","lead_created_at":"2016-10-01
         23:55:00 UTC","free_trial_started_at":"2016-10-12 11:12:00 UTC"}'
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v1.0.1
       Content-Type:
       - application/json
       Authorization:
@@ -67,40 +55,29 @@ http_interactions:
   response:
     status:
       code: 201
-      message:
+      message: Created
     headers:
       server:
       - nginx/1.10.1
       date:
-      - Tue, 08 Nov 2016 08:57:33 GMT
+      - Tue, 16 Mar 2021 12:27:19 GMT
       content-type:
-      - application/json; charset=utf-8
+      - application/json
       transfer-encoding:
       - chunked
       connection:
-      - close
-      x-frame-options:
-      - SAMEORIGIN
-      x-xss-protection:
-      - 1; mode=block
-      x-content-type-options:
-      - nosniff
-      etag:
-      - W/"edb1e5e3324d47803eccb229a21363df"
-      cache-control:
-      - max-age=0, private, must-revalidate
-      x-request-id:
-      - bf049e2c-b057-4d90-85bf-f90c9ca98b31
-      x-runtime:
-      - '0.158973'
-      strict-transport-security:
-      - max-age=15768000
+      - keep-alive
+      status:
+      - 201 Created
+      access-control-allow-credentials:
+      - 'true'
     body:
       encoding: UTF-8
-      string: '{"uuid":"cus_709bf73d-dc7c-4fb3-825d-a32c7fe5be16","external_id":"X1234","name":"Test
-        Customer","company":"","email":"test@example.com","city":"Berlin","state":"","country":"DE","zip":"","lead_created_at":"2016-10-01T23:55:00.000Z","free_trial_started_at":"2016-10-12T11:12:00.000Z","data_source_uuid":"ds_632433ee-a591-11e6-aa29-ff9ccc9a74aa"}'
+      string: '{"id":93760512,"uuid":"cus_f340970a-8652-11eb-a9f8-cfc7971a103f","external_id":"X1234","name":"Test
+        Customer","email":"test@example.com","status":"Lead","customer-since":null,"attributes":{"custom":{},"clearbit":{},"stripe":{},"tags":[]},"data_source_uuid":"ds_f2f67ad0-8652-11eb-a9f8-37471a677085","data_source_uuids":["ds_f2f67ad0-8652-11eb-a9f8-37471a677085"],"external_ids":["X1234"],"company":"","country":"DE","state":null,"city":"Berlin","zip":null,"lead_created_at":"2016-10-01T23:55:00.000Z","free_trial_started_at":"2016-10-12T11:12:00.000Z","address":{"country":"Germany","state":null,"city":"Berlin","address_zip":null},"mrr":0,"arr":0,"billing-system-url":null,"chartmogul-url":"https://app.chartmogul.com/#customers/93760512-Test_Customer","billing-system-type":"Import
+        API","currency":"USD","currency-sign":"$"}'
     http_version:
-  recorded_at: Tue, 08 Nov 2016 08:57:33 GMT
+  recorded_at: Tue, 16 Mar 2021 12:27:19 GMT
 - request:
     method: get
     uri: https://api.chartmogul.com/v1/customers
@@ -109,7 +86,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v1.0.1
       Content-Type:
       - application/json
       Authorization:
@@ -117,81 +94,62 @@ http_interactions:
   response:
     status:
       code: 200
-      message:
+      message: OK
     headers:
       server:
       - nginx/1.10.1
       date:
-      - Tue, 08 Nov 2016 08:57:34 GMT
+      - Tue, 16 Mar 2021 12:27:19 GMT
       content-type:
-      - application/json; charset=utf-8
+      - application/json
       transfer-encoding:
       - chunked
       connection:
-      - close
-      x-frame-options:
-      - SAMEORIGIN
-      x-xss-protection:
-      - 1; mode=block
-      x-content-type-options:
-      - nosniff
-      etag:
-      - W/"eb861872d3bd01a055485e96ccf38898"
-      cache-control:
-      - max-age=0, private, must-revalidate
-      x-request-id:
-      - 32f87d7c-f944-405d-a87c-2195f175940a
-      x-runtime:
-      - '0.022802'
-      strict-transport-security:
-      - max-age=15768000
+      - keep-alive
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
     body:
-      encoding: UTF-8
-      string: '{"entries":[{"uuid":"cus_709bf73d-dc7c-4fb3-825d-a32c7fe5be16","external_id":"X1234","name":"Test
-        Customer","company":"","email":"test@example.com","city":"Berlin","state":"","country":"DE","zip":"","lead_created_at":"2016-10-01T23:55:00.000Z","free_trial_started_at":"2016-10-12T11:12:00.000Z","data_source_uuid":"ds_632433ee-a591-11e6-aa29-ff9ccc9a74aa"}],"current_page":1,"total_pages":1,"has_more":false,"per_page":50,"page":1}'
+      encoding: ASCII-8BIT
+      string: '{"entries":[{"id":93760512,"uuid":"cus_f340970a-8652-11eb-a9f8-cfc7971a103f","external_id":"X1234","name":"Test
+        Customer","email":"test@example.com","status":"Lead","customer-since":null,"attributes":{"custom":{},"clearbit":{},"stripe":{},"tags":[]},"data_source_uuid":"ds_f2f67ad0-8652-11eb-a9f8-37471a677085","data_source_uuids":["ds_f2f67ad0-8652-11eb-a9f8-37471a677085"],"external_ids":["X1234"],"company":"","country":"DE","state":null,"city":"Berlin","zip":null,"lead_created_at":"2016-10-01T23:55:00.000Z","free_trial_started_at":"2016-10-12T11:12:00.000Z","address":{"country":"Germany","state":null,"city":"Berlin","address_zip":null},"mrr":0,"arr":0,"billing-system-url":null,"chartmogul-url":"https://app.chartmogul.com/#customers/93760512-Test_Customer","billing-system-type":"Import
+        API","currency":"USD","currency-sign":"$"}],"current_page":1,"total_pages":1,"has_more":false,"per_page":200,"page":1}'
     http_version:
-  recorded_at: Tue, 08 Nov 2016 08:57:34 GMT
+  recorded_at: Tue, 16 Mar 2021 12:27:19 GMT
 - request:
     method: delete
-    uri: https://api.chartmogul.com/v1/customers/cus_709bf73d-dc7c-4fb3-825d-a32c7fe5be16
+    uri: https://api.chartmogul.com/v1/customers/cus_f340970a-8652-11eb-a9f8-cfc7971a103f
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v1.0.1
       Authorization:
       - Basic hidden
   response:
     status:
       code: 204
-      message:
+      message: No Content
     headers:
       server:
       - nginx/1.10.1
       date:
-      - Tue, 08 Nov 2016 08:57:34 GMT
+      - Tue, 16 Mar 2021 12:28:19 GMT
       connection:
-      - close
-      x-frame-options:
-      - SAMEORIGIN
-      x-xss-protection:
-      - 1; mode=block
-      x-content-type-options:
-      - nosniff
-      cache-control:
-      - no-cache
-      x-request-id:
-      - f163488f-bbea-4937-897b-ee08b69a4560
-      x-runtime:
-      - '0.015696'
-      strict-transport-security:
-      - max-age=15768000
+      - keep-alive
+      status:
+      - 204 No Content
+      access-control-allow-credentials:
+      - 'true'
     body:
       encoding: UTF-8
       string: ''
     http_version:
-  recorded_at: Tue, 08 Nov 2016 08:57:34 GMT
+  recorded_at: Tue, 16 Mar 2021 12:28:19 GMT
 - request:
     method: get
     uri: https://api.chartmogul.com/v1/customers
@@ -200,7 +158,7 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - Faraday v0.9.2
+      - Faraday v1.0.1
       Content-Type:
       - application/json
       Authorization:
@@ -208,37 +166,27 @@ http_interactions:
   response:
     status:
       code: 200
-      message:
+      message: OK
     headers:
       server:
       - nginx/1.10.1
       date:
-      - Tue, 08 Nov 2016 08:57:34 GMT
+      - Tue, 16 Mar 2021 12:28:20 GMT
       content-type:
-      - application/json; charset=utf-8
+      - application/json
       transfer-encoding:
       - chunked
       connection:
-      - close
-      x-frame-options:
-      - SAMEORIGIN
-      x-xss-protection:
-      - 1; mode=block
-      x-content-type-options:
-      - nosniff
-      etag:
-      - W/"82f80d77a5a88d6de206bb1feeb897cc"
-      cache-control:
-      - max-age=0, private, must-revalidate
-      x-request-id:
-      - 770d6629-03d8-4f55-8bec-dde047828e7e
-      x-runtime:
-      - '0.019712'
-      strict-transport-security:
-      - max-age=15768000
+      - keep-alive
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
     body:
-      encoding: UTF-8
-      string: '{"customers":[],"current_page":1,"total_pages":0,"has_more":false,"per_page":50,"page":1}'
+      encoding: ASCII-8BIT
+      string: '{"entries":[],"current_page":1,"total_pages":1,"has_more":false,"per_page":200,"page":1}'
     http_version:
-  recorded_at: Tue, 08 Nov 2016 08:57:34 GMT
-recorded_with: VCR 3.0.3
+  recorded_at: Tue, 16 Mar 2021 12:28:20 GMT
+recorded_with: VCR 5.1.0

data/fixtures/vcr_cassettes/ChartMogul_Metrics_ActivitiesExport/get_activities_export.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.chartmogul.com/v1/activities_export/44037b8f-4a89-4fc6-8114-2288c71a9518
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v1.0.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - Basic hidden
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      server:
+      - nginx/1.10.1
+      date:
+      - Fri, 09 Jul 2021 14:06:07 GMT
+      content-type:
+      - application/json
+      transfer-encoding:
+      - chunked
+      connection:
+      - keep-alive
+      vary:
+      - Accept-Encoding, Accept-Encoding
+      status:
+      - 200 OK
+      access-control-allow-credentials:
+      - 'true'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"44037b8f-4a89-4fc6-8114-2288c71a9518","status":"succeeded","file_url":"https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-062ea48c-5d74-46dd-bd60-23206cdc241a.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256\u0026X-Amz-Credential=123%2Feu-west-1%2Fs3%2Faws4_request\u0026X-Amz-Date=20210709T135547Z\u0026X-Amz-Expires=604800\u0026X-Amz-SignedHeaders=host\u0026X-Amz-Signature=abc","params":{"kind":"activities","params":{"end_date":"2020-12-31
+        00:00:00 +0000","start_date":"2020-01-01 00:00:00 +0000","activity_type":"new_biz"}},"expires_at":"2021-07-16T13:55:47+00:00","created_at":"2021-07-09T13:55:44+00:00"}'
+    http_version:
+  recorded_at: Fri, 09 Jul 2021 14:06:07 GMT
+recorded_with: VCR 5.1.0