app_store_connect_jwt 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62dcbed3328ffadd0bc9835827e963cb83e2f998d59afbc68d858c1a5c0efcfa
-  data.tar.gz: 5f0bc245b396b303331d3a3b5971a38c4fa425d16e857a02c8af72f0b5cfd282
+  metadata.gz: c71424de5f38c22a6d37033331e216d60aae61048d99ef31ecf87bcaa944604a
+  data.tar.gz: bb19b41b06c00c459303563fca6ad9a4258313f923aebff7db594ee71f3eef4d
 SHA512:
-  metadata.gz: 2bae4b64b467d99f8fc7ebce578a2a600df9f332e22cca867f9637431ed50f3e40679e331683a16179932f72895ce9472c6113c6666c79e5cd3be95796a4dd65
-  data.tar.gz: acdcf3d719bc3f12271a9876aa2f629eef37c4ab9a198f19aa9a7e58b36208517083a14b2f8f9a9aa45a113d9f51479e7334010c503ddd762921f1b7a512324c
+  metadata.gz: 82a3c208645dddbbec4a0dc63bf09522601e5f3aced6cc04199b8215074f6cdc78de41c833cd63413fefb62e9febad35b89ca524920529dee6c5fdb5e2e2e620
+  data.tar.gz: 6c9a1e669a463caebdcdaeb77db2222c35ab542f2e54618bfd60ae6edfaccbd3af2c6b68366212bda334e84da02d3c7e46a81ab04ddb948f62de21dff27575d2

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+---
+blank_issues_enabled: true
+contact_links:
+  - name: Twitter
+    url: https://twitter.com/kyledecot
+    about: Contact me on Twitter

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/lint.yml

@@ -0,0 +1,39 @@
+---
+name: Lint
+
+on:
+  push:
+
+jobs:
+  yamllint:
+    name: yamllint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.x
+      - name: Install
+        run: |
+          pip install --user --no-warn-script-location yamllint
+      - name: Run
+        run: /home/runner/.local/bin/yamllint .
+
+  rubocop:
+    name: rubocop
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - name: Install dependencies
+        run: |
+          gem install bundler
+          bundle install --jobs=3 --retry=3
+      - name: Run rubocop
+        run: bundle exec rubocop -P -fq

data/.github/workflows/test.yml

@@ -8,7 +8,7 @@ on:
 
 jobs:
   rspec:
-    name: RSpec
+    name: rspec
     runs-on: ubuntu-latest
 
     steps:
@@ -26,7 +26,7 @@ jobs:
           ./cc-test-reporter before-build
       - name: Run rspec
         run: |
-          GLI_DEBUG=true bundle exec rspec
+          bundle exec rspec
           ./cc-test-reporter after-build --exit-code $? -t simplecov
         env:
           CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}

data/.rubocop.yml

@@ -10,17 +10,17 @@
 # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
 #
 ---
-Metrics/MethodLength:
+Layout/LineLength:
   Enabled: false
 
 Metrics/BlockLength:
   Enabled: false
 
-Style/Documentation:
+Metrics/ClassLength:
   Enabled: false
 
-Layout/LineLength:
+Metrics/MethodLength:
   Enabled: false
 
-Metrics/ClassLength:
+Style/Documentation:
   Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.5

data/.yamllint

@@ -0,0 +1,5 @@
+---
+extends: default
+rules:
+  line-length: disable
+  truthy: disable

data/Gemfile

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in app_store_connect_jwt.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_store_connect_jwt (0.2.0)
+    app_store_connect_jwt (0.3.0)
       gli
       jwt
 
@@ -12,11 +12,35 @@ GEM
     coderay (1.1.2)
     diff-lcs (1.3)
     docile (1.3.2)
+    ffi (1.12.2)
+    formatador (0.2.5)
     gli (2.19.0)
+    guard (2.16.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     jaro_winkler (1.5.4)
     json (2.2.0)
     jwt (2.2.1)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.4)
     method_source (0.9.2)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.19.1)
     parser (2.7.0.2)
       ast (~> 2.4.0)
@@ -25,6 +49,9 @@ GEM
       method_source (~> 0.9.0)
     rainbow (3.0.0)
     rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -46,11 +73,13 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
+    shellany (0.0.1)
     simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    thor (1.0.1)
     timecop (0.9.1)
     unicode-display_width (1.6.1)
 
@@ -60,6 +89,7 @@ PLATFORMS
 DEPENDENCIES
   app_store_connect_jwt!
   bundler (~> 2.0)
+  guard-rspec
   pry
   rake (~> 10.0)
   rspec (~> 3.0)
@@ -68,4 +98,4 @@ DEPENDENCIES
   timecop
 
 BUNDLED WITH
-   2.0.1
+   2.0.2

data/Guardfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,8 +1,10 @@
 # App Store Connect–JWT
 
-![Test](https://github.com/kyledecot/app_store_connect_jwt/workflows/Test/badge.svg) [![Gem Version](https://badge.fury.io/rb/app_store_connect_jwt.svg)](https://badge.fury.io/rb/app_store_connect_jwt) [![Maintainability](https://api.codeclimate.com/v1/badges/e13c94f97898e74f34a9/maintainability)](https://codeclimate.com/github/kyledecot/hard_cider/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e13c94f97898e74f34a9/test_coverage)](https://codeclimate.com/github/kyledecot/hard_cider/test_coverage)
+![Test](https://github.com/kyledecot/app_store_connect_jwt/workflows/Test/badge.svg) ![Lint](https://github.com/kyledecot/app_store_connect_jwt/workflows/Lint/badge.svg) [![Gem Version](https://badge.fury.io/rb/app_store_connect_jwt.svg)](https://badge.fury.io/rb/app_store_connect_jwt) [![Maintainability](https://api.codeclimate.com/v1/badges/e13c94f97898e74f34a9/maintainability)](https://codeclimate.com/github/kyledecot/hard_cider/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/e13c94f97898e74f34a9/test_coverage)](https://codeclimate.com/github/kyledecot/hard_cider/test_coverage)
 
-Generate App Store Connect API JWT (JSON Web Token) 
+Generate App Store Connect API JWT (JSON Web Token) according to Apple's App Store Connect API Documentation:
+
+https://developer.apple.com/documentation/appstoreconnectapi/generating_tokens_for_api_requests
 
 ## Installation
 
@@ -25,10 +27,19 @@ Or install it yourself as:
 ### CLI 
 
 ```sh
-app-store-connect-jwt generate \
-  --issuer-id=$APP_STORE_CONNECT_ISSUER_ID \
-  --key-id=$APP_STORE_CONNECT_KEY_ID \
-  --private-key-path=$APP_STORE_CONNECT_PRIVATE_KEY_PATH
+$ app-store-connect-jwt generate \
+    --issuer-id=$APP_STORE_CONNECT_ISSUER_ID \
+    --key-id=$APP_STORE_CONNECT_KEY_ID \
+    --private-key-path=$APP_STORE_CONNECT_PRIVATE_KEY_PATH
+```
+
+:information_desk_person: _Pro Tip: if you have the environment variables set that are listed above you can omit the flags entirely and the CLI will automatically pick up on them, thus making the command `app-store-connect-jwt generate`!_
+
+#### cURL 
+
+```sh
+$ curl -H "Authorization: Bearer $(app-store-connect-jwt generate)" \
+    https://api.appstoreconnect.apple.com/v1/apps
 ```
 
 ### Ruby
@@ -38,9 +49,11 @@ puts AppStoreConnect::JWT.new(
   issuer_id: ENV["APP_STORE_CONNECT_ISSUER_ID"],
   key_id: ENV["APP_STORE_CONNECT_KEY_ID"],
   private_key_path: ENV["APP_STORE_CONNECT_PRIVATE_KEY_PATH"]
-)
+).token
 ```
 
+:information_desk_person: _Pro Tip: `#token` is aliased to `#to_s` so in this example the `.token` is superfolus!_
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/app_store_connect_jwt.gemspec

@@ -25,13 +25,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'simplecov'
-
+  spec.add_development_dependency 'timecop'
 
   spec.add_runtime_dependency 'gli'
   spec.add_runtime_dependency 'jwt'

data/lib/app_store_connect/jwt.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'jwt'
+require 'app_store_connect/jwt/utils'
 require 'app_store_connect/jwt/version'
 
 module AppStoreConnect
@@ -8,14 +8,37 @@ module AppStoreConnect
     AUDIENCE = 'appstoreconnect-v1'
     ALGORITHM = 'ES256'
 
-    attr_reader :issuer_id, :key_id, :private_key
+    # App Store Connect API Issuer ID
+    # @return [String]
+    attr_reader :issuer_id
 
+    # App Store Connect API Key ID
+    # @return [String]
+    attr_reader :key_id
+
+    # App Store Connect API Private Key
+    # @return [OpenSSL::PKey::EC]
+    attr_reader :private_key
+
+    # @param token [String]
+    # @param private_key_path [String] Path to App Store Connect API Private Key (.p8)
+    # @return [Array<Hash>]
+    def self.decode(token:, private_key_path:)
+      private_key = Utils.private_key(path: private_key_path)
+
+      Utils.decode(token, private_key, ALGORITHM)
+    end
+
+    # @param issuer_id [String] App Store Connect API Issuer ID
+    # @param key_id [String] App Store Connect API Key ID
+    # @param private_key_path [String] Path to App Store Connect API Private Key (.p8)
     def initialize(issuer_id:, key_id:, private_key_path:)
       @issuer_id = issuer_id
       @key_id = key_id
-      @private_key = OpenSSL::PKey.read(File.read(File.expand_path(private_key_path)))
+      @private_key = Utils.private_key(path: private_key_path)
     end
 
+    # @return [Hash]
     def payload
       {
         exp: Time.now.to_i + 20 * 60,
@@ -24,12 +47,16 @@ module AppStoreConnect
       }
     end
 
+    # @return [Hash]
     def header_fields
       { kid: key_id }
     end
 
-    def to_s
-      ::JWT.encode(payload, private_key, ALGORITHM, header_fields)
+    # @return [String]
+    def token
+      Utils.encode(payload, private_key, ALGORITHM, header_fields)
     end
+
+    alias to_s token
   end
 end

data/lib/app_store_connect/jwt/utils.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'jwt'
+require 'openssl'
+
+module AppStoreConnect
+  class JWT
+    module Utils
+      # @param payload [Hash]
+      # @param private_key [OpenSSL::PKey::EC]
+      # @param algorithm [String]
+      # @param header_fields [Hash]
+      # @return [String]
+      def self.encode(payload, private_key, algorithm, header_fields)
+        ::JWT.encode(payload, private_key, algorithm, header_fields)
+      end
+
+      # @param token [String]
+      # @param private_key [OpenSSL::PKey::EC]
+      # @param algorithm [String]
+      # @return [Array<Hash>]
+      def self.decode(token, private_key, algorithm)
+        ::JWT.decode(token, private_key, true, algorithm: algorithm)
+      end
+
+      # @param path [String]
+      # @return [OpenSSL::PKey::EC]
+      def self.private_key(path:)
+        OpenSSL::PKey.read(File.read(File.expand_path(path)))
+      end
+    end
+  end
+end

data/lib/app_store_connect/jwt/version.rb

@@ -2,6 +2,6 @@
 
 module AppStoreConnect
   class JWT
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: app_store_connect_jwt
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kyle Decot
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: timecop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -144,13 +158,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/workflows/lint.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- ".ruby-version"
+- ".yamllint"
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -161,6 +181,7 @@ files:
 - lib/app_store_connect.rb
 - lib/app_store_connect/jwt.rb
 - lib/app_store_connect/jwt/cli.rb
+- lib/app_store_connect/jwt/utils.rb
 - lib/app_store_connect/jwt/version.rb
 homepage: https://github.com/kyledecot/app_store_connect_jwt
 licenses:
@@ -181,8 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Generate App Store Connect JWT

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.5
-before_install: gem install bundler -v 2.0.1