app_store_connect_jwt 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c71424de5f38c22a6d37033331e216d60aae61048d99ef31ecf87bcaa944604a
-  data.tar.gz: bb19b41b06c00c459303563fca6ad9a4258313f923aebff7db594ee71f3eef4d
+  metadata.gz: c5cc4cc4768241760d8a0d1a6898804ee2910655af8af4920ae245369390c4e3
+  data.tar.gz: 9e558fc1e1efa9b6277791b9f71586bc5f463b6d91845841d7d0f3be616dbf79
 SHA512:
-  metadata.gz: 82a3c208645dddbbec4a0dc63bf09522601e5f3aced6cc04199b8215074f6cdc78de41c833cd63413fefb62e9febad35b89ca524920529dee6c5fdb5e2e2e620
-  data.tar.gz: 6c9a1e669a463caebdcdaeb77db2222c35ab542f2e54618bfd60ae6edfaccbd3af2c6b68366212bda334e84da02d3c7e46a81ab04ddb948f62de21dff27575d2
+  metadata.gz: 58ee8eb7b987a1594245cac753eb5325b9d7f0cf969cc3ce3c6d35e3b6d38e61ff4a261452e7af2b2a80b3cae226ac8b25f1633f1eea04a1d1f0e1175d8deb8d
+  data.tar.gz: c99f2b5e8cd149e7d0200d27165dcf834c2af9a3b125401fa6c458c8003176a190c3012e902752bcc3804496cb82cff2f60fddc58329f07b25903208982505cc

data/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+---
+name: Publish
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  build:
+    name: Build + Publish
+    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: Configure Bundler
+        run: |
+          gem install bundler
+          bundle install --jobs=3 --retry=3
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n:github: Bearer ${GITHUB_PACKAGE_REPOSITORY_AUTH_TOKEN}" > $HOME/.gem/credentials
+        env:
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          GITHUB_PACKAGE_REPOSITORY_AUTH_TOKEN: ${{secrets.GITHUB_PACKAGE_REPOSITORY_AUTH_TOKEN}}
+
+      - name: Build Gem
+        run: |
+          gem build *.gemspec
+      - name: Publish to RubyGems
+        run: bundle exec ./bin/publish --rubygems
+
+      - name: Publish to Github Package Repository
+        run: bundle exec ./bin/publish --github

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kyle.decot@icloud.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    app_store_connect_jwt (0.3.0)
-      gli
-      jwt
+    app_store_connect_jwt (0.4.0)
+      gli (~> 2.19)
+      jwt (~> 2.2)
 
 GEM
   remote: https://rubygems.org/
@@ -89,13 +89,13 @@ PLATFORMS
 DEPENDENCIES
   app_store_connect_jwt!
   bundler (~> 2.0)
-  guard-rspec
-  pry
+  guard-rspec (~> 4.7)
+  pry (~> 0.12)
   rake (~> 10.0)
   rspec (~> 3.0)
-  rubocop
-  simplecov
-  timecop
+  rubocop (~> 0.79)
+  simplecov (~> 0.17)
+  timecop (~> 0.9)
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -26,33 +26,52 @@ Or install it yourself as:
 
 ### CLI 
 
+#### Encoding 
+
 ```sh
-$ app-store-connect-jwt generate \
+$ app-store-connect-jwt encode \
     --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`!_
+: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 encode`!_
+
+#### Decoding
+
+```sh
+$ app-store-connect-jwt decode \
+    --token="..." \
+    --private-key-path=$APP_STORE_CONNECT_PRIVATE_KEY_PATH
+```
 
 #### cURL 
 
 ```sh
-$ curl -H "Authorization: Bearer $(app-store-connect-jwt generate)" \
+$ curl -H "Authorization: Bearer $(app-store-connect-jwt encode)" \
     https://api.appstoreconnect.apple.com/v1/apps
 ```
 
 ### Ruby
 
+#### Encoding
+
 ```ruby 
-puts AppStoreConnect::JWT.new(
+AppStoreConnect::JWT.encode(
   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!_
+#### Decoding
+
+```ruby
+AppStoreConnect::JWT.decode(
+  token: token,
+  private_key_path: ENV["APP_STORE_CONNECT_PRIVATE_KEY_PATH"]
+)
+```
 
 ## Development
 

data/app_store_connect_jwt.gemspec

@@ -25,14 +25,14 @@ 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 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'pry', '~> 0.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'rubocop', '~> 0.79'
+  spec.add_development_dependency 'simplecov', '~> 0.17'
+  spec.add_development_dependency 'timecop', '~> 0.9'
 
-  spec.add_runtime_dependency 'gli'
-  spec.add_runtime_dependency 'jwt'
+  spec.add_runtime_dependency 'gli', '~> 2.19'
+  spec.add_runtime_dependency 'jwt', '~> 2.2'
 end

data/bin/publish

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'app_store_connect/jwt/version'
+
+OPTIONS = {
+  hosts: [],
+  version: AppStoreConnect::JWT::VERSION
+}
+
+HOSTS = {
+  rubygems: 'https://rubygems.org',
+  github: 'https://rubygems.pkg.github.com/kyledecot'
+}.freeze
+
+OptionParser.new do |parser|
+  HOSTS.keys.each do |key|
+    parser.on("--#{key}") do
+      OPTIONS[:hosts] << key
+    end
+  end
+
+  parser.on('--version VERSION') do |version|
+    OPTIONS[:version] = version
+  end
+
+  parser.on('--help', '-h') do
+    puts parser
+    exit(0)
+  end
+end.parse!
+
+OPTIONS[:hosts].each do |key|
+  ENV['RUBYGEMS_HOST'] = HOSTS.fetch(key)
+
+  system "gem push -k #{key} app_store_connect_jwt-#{OPTIONS[:version]}.gem"
+end

data/lib/app_store_connect/jwt.rb

@@ -8,55 +8,25 @@ module AppStoreConnect
     AUDIENCE = 'appstoreconnect-v1'
     ALGORITHM = 'ES256'
 
-    # App Store Connect API Issuer ID
-    # @return [String]
-    attr_reader :issuer_id
-
-    # App Store Connect API Key ID
+    # @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)
     # @return [String]
-    attr_reader :key_id
+    def self.encode(issuer_id:, key_id:, private_key_path:)
+      payload = Utils.payload(issuer_id, AUDIENCE)
+      header_fields = Utils.header_fields(key_id)
+      private_key = Utils.private_key(private_key_path)
 
-    # App Store Connect API Private Key
-    # @return [OpenSSL::PKey::EC]
-    attr_reader :private_key
+      Utils.encode(payload, private_key, ALGORITHM, header_fields)
+    end
 
     # @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)
+      private_key = Utils.private_key(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 = Utils.private_key(path: private_key_path)
-    end
-
-    # @return [Hash]
-    def payload
-      {
-        exp: Time.now.to_i + 20 * 60,
-        iss: issuer_id,
-        aud: AUDIENCE
-      }
-    end
-
-    # @return [Hash]
-    def header_fields
-      { kid: key_id }
-    end
-
-    # @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/cli.rb

@@ -8,19 +8,45 @@ module AppStoreConnect
     class CLI
       extend GLI::App
 
-      command :generate do |c|
-        c.flag %i[issuer-id i], required: true, default_value: ENV['APP_STORE_CONNECT_ISSUER_ID'], mask: true
-        c.flag %i[key-id k], required: true, default_value: ENV['APP_STORE_CONNECT_KEY_ID'], mask: true
-        c.flag %i[private-key-path p], required: true, default_value: ENV['APP_STORE_CONNECT_PRIVATE_KEY_PATH']
+      command :encode do |c|
+        c.flag %i[issuer-id i],
+               required: true,
+               default_value: ENV['APP_STORE_CONNECT_ISSUER_ID'],
+               mask: true
+
+        c.flag %i[key-id k],
+               required: true,
+               default_value: ENV['APP_STORE_CONNECT_KEY_ID'],
+               mask: true
+
+        c.flag %i[private-key-path p],
+               required: true,
+               default_value: ENV['APP_STORE_CONNECT_PRIVATE_KEY_PATH']
 
         c.action do |_, options, _|
-          puts AppStoreConnect::JWT.new(
+          puts AppStoreConnect::JWT.encode(
             issuer_id: options.fetch(:"issuer-id"),
             key_id: options.fetch(:"key-id"),
             private_key_path: options.fetch(:"private-key-path")
           )
         end
       end
+
+      command :decode do |c|
+        c.flag %i[token t],
+               required: true
+
+        c.flag %i[private-key-path p],
+               required: true,
+               default_value: ENV['APP_STORE_CONNECT_PRIVATE_KEY_PATH']
+
+        c.action do |_, options, _|
+          puts AppStoreConnect::JWT.decode(
+            token: options.fetch(:token),
+            private_key_path: options.fetch(:"private-key-path")
+          )
+        end
+      end
     end
   end
 end

data/lib/app_store_connect/jwt/utils.rb

@@ -23,9 +23,26 @@ module AppStoreConnect
         ::JWT.decode(token, private_key, true, algorithm: algorithm)
       end
 
+      # @param key_id [String]
+      # @return [Hash]
+      def self.header_fields(key_id)
+        { kid: key_id }
+      end
+
+      # @param issuer_id [String]
+      # @param audience [String]
+      # @return [Hash]
+      def self.payload(issuer_id, audience)
+        {
+          exp: Time.now.to_i + 20 * 60,
+          iss: issuer_id,
+          aud: audience
+        }
+      end
+
       # @param path [String]
       # @return [OpenSSL::PKey::EC]
-      def self.private_key(path:)
+      def self.private_key(path)
         OpenSSL::PKey.read(File.read(File.expand_path(path)))
       end
     end

data/lib/app_store_connect/jwt/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_store_connect_jwt
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kyle Decot
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,30 +28,30 @@ dependencies:
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,72 +84,72 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.79'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.79'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.19'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.2'
 description: Generate App Store Connect JWT
 email:
 - kyle.decot@icloud.com
@@ -162,12 +162,14 @@ files:
 - ".github/ISSUE_TEMPLATE/config.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/lint.yml"
+- ".github/workflows/publish.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".yamllint"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -176,6 +178,7 @@ files:
 - Rakefile
 - app_store_connect_jwt.gemspec
 - bin/console
+- bin/publish
 - bin/setup
 - exe/app-store-connect-jwt
 - lib/app_store_connect.rb