connector_kit_fork 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2bde5885b04d01922fee2de21b504192e073f1351b6e13e37c773e3a8121dcf
+  data.tar.gz: 359c57f254d32845ef32f8aab4721cdc6901241013c89de14788dc6b32f45b61
+SHA512:
+  metadata.gz: 24a8a6cf8a1ea932cd7530722c782bbb059ec25c7496115ad72e155d46ed7ef63d8e8a28e766a3b53b359366d69b9d1c3540454853e5f24ad6f2d6c41808f6a9
+  data.tar.gz: 941abfb5f263bf9eccaa1d97c97862ac7198329205f8e84b00e09c85e806241bad0351d1b10251d8d0358cec2d6e8af1946a1a3686461fbfef458f2c56f3502b

data/.gitignore

@@ -0,0 +1,13 @@
+*.gem
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in connector_kit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    connector_kit_fork (0.3.1)
+      httparty (~> 0.16.3)
+      jwt (~> 2.1, >= 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    jwt (2.2.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0212)
+    multi_xml (0.6.0)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  connector_kit_fork!
+  rake
+  rspec
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Simon Jarbrant
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# ConnectorKit 🔌
+
+[![Gem Version](https://badge.fury.io/rb/connector_kit.svg)](https://badge.fury.io/rb/connector_kit)
+
+A simple Ruby gem for communicating with the [App Store Connect API](https://developer.apple.com/app-store-connect/api). Currently supported features:
+
+ - [x] List users
+ - [x] List apps
+ - [x] List builds of an app
+ - [x] Get build details for a specific build
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'connector_kit'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install connector_kit
+```
+
+## Usage
+
+Before you can use this gem you need to set up a new key in the App Store Connect "Users and Access" section. More detailed info here: [App Store Connect API documentation](https://developer.apple.com/documentation/appstoreconnectapi)
+
+First, require the gem and set up a client. The `Client` class has three constructor arguments:
+
+ - `issuer_id`: The Issuer ID of your organisation (you can find this in App Store Connect)
+ - `key_id`: The Key ID of the App Store Connect API key you want to use
+ - `private_key_file_path`: The path to the `*.p8` file that you downloaded as part of creating an App Store Connect API key
+
+```ruby
+require 'connector_kit'
+
+client = ConnectorKit::Client.new(
+  '8e2f3845-63ec-4865-8be7-f7cbb3c099db',
+  'E28E8EE0B4CE',
+  'AuthKey_E28E8EE0B4CE.p8'
+)
+```
+
+After initialising the client, it will generate a JWT token as described in the documentation for the App Store Connect API. It's valid for 20 minutes. Now you can use it to fetch information from the API:
+
+```ruby
+# Fetches all apps in the organisation
+apps = client.apps
+```
+
+```ruby
+# Fetches all builds for an app
+builds = client.app_builds(app)
+```
+
+```ruby
+# Fetches build details for a build
+build_details = client.build_beta_details(build)
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/simba909/connector_kit.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "connector_kit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/connector_kit.gemspec

@@ -0,0 +1,29 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "connector_kit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "connector_kit_fork"
+  spec.version       = ConnectorKit::VERSION
+  spec.authors       = ["Simon Jarbrant"]
+  spec.email         = ["simonjarbrant@gmail.com"]
+
+  spec.summary       = "A gem for communicating with the App Store Connect API."
+  spec.description   = "A gem for communicating with the App Store Connect API."
+  spec.homepage      = "https://github.com/simba909/connector_kit"
+  spec.license       = "MIT"
+
+  all_files  = `git ls-files`.split("\n")
+  test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  spec.files         = all_files - test_files
+  spec.test_files    = test_files
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "httparty", "~> 0.16.3"
+  spec.add_dependency "jwt", "~> 2.1", ">= 2.1.0"
+end

data/lib/connector_kit.rb

@@ -0,0 +1,63 @@
+require 'connector_kit/httpclient.rb'
+require 'connector_kit/token_generator'
+require 'connector_kit/version'
+require 'connector_kit/mappers/app_list_response_mapper'
+require 'connector_kit/mappers/app_response_mapper'
+require 'connector_kit/mappers/user_list_response_mapper'
+require 'connector_kit/mappers/build_list_response_mapper'
+require 'connector_kit/mappers/build_details_response_mapper'
+require 'connector_kit/mappers/app_version_mapper'
+
+module ConnectorKit
+  # Class used for communicating with the App Store Connect API
+  class Client
+
+    def initialize(issuer_id, key_id, private_key)
+      token_generator = TokenGenerator.new(
+        issuer_id,
+        key_id,
+        private_key
+      )
+
+      @httpclient = HTTPClient.new('https://api.appstoreconnect.apple.com/v1')
+      @httpclient.class.headers(
+        'Authorization' => "Bearer #{token_generator.generate_token}"
+      )
+    end
+
+    def apps
+      @httpclient.get '/apps', AppListResponseMapper.new
+    end
+
+    def users
+      @httpclient.get '/users', UserListResponseMapper.new
+    end
+
+    def app_builds(app)
+      @httpclient.get "/apps/#{app.id}/builds", BuildListResponseMapper.new
+    end
+
+    def app(id)
+      @httpclient.get "/apps/#{id}", AppResponseMapper.new
+    end
+
+    def prepare_submition_versions(id)
+      releaseVersion(id, "PREPARE_FOR_SUBMISSION")
+    end
+
+    def ready_sale_versions(id)
+      releaseVersion(id, "READY_FOR_SALE")
+    end
+
+    def release_version(id, state)
+      @httpclient.get "/apps/#{id}/appStoreVersions?filter[appStoreState]=#{state}", VersionResponseMapper.new
+    end
+
+    def build_beta_details(build)
+      @httpclient.get(
+        "/buildBetaDetails/#{build.id}",
+        BuildDetailsResponseMapper.new
+      )
+    end
+  end
+end

data/lib/connector_kit/exceptions.rb

@@ -0,0 +1,15 @@
+module ConnectorKit
+  class Error < StandardError; end
+
+  # Simple model class for representing errors in the App Store Connect API
+  class APIError < Error
+    attr_reader :detail, :status
+
+    def initialize(message, detail, status)
+      super(message)
+
+      @detail = detail
+      @status = status
+    end
+  end
+end

data/lib/connector_kit/httpclient.rb

@@ -0,0 +1,30 @@
+require 'httparty'
+
+require 'connector_kit/exceptions'
+
+module ConnectorKit
+  # Simple HTTP client wrapper for HTTParty
+  class HTTPClient
+    include HTTParty
+
+    def initialize(target_uri)
+      self.class.base_uri(target_uri)
+    end
+
+    def get(url, response_mapper)
+      response = self.class.get(url)
+
+      raise make_api_error(response) unless response.code == 200
+
+      response_mapper.map(response.parsed_response['data'])
+    end
+
+    private
+
+    def make_api_error(response)
+      # For the time being, the first error received is enough
+      error = response.parsed_response['errors'].first
+      APIError.new(error['title'], error['detail'], error['status'])
+    end
+  end
+end

data/lib/connector_kit/mappers/app_list_response_mapper.rb

@@ -0,0 +1,10 @@
+require 'connector_kit/models/app'
+
+module ConnectorKit
+  # Mapper between a HTTParty response and a list of Apps
+  class AppListResponseMapper
+    def map(data)
+      data.map { |app| App.new(app) }
+    end
+  end
+end

data/lib/connector_kit/mappers/app_response_mapper.rb

@@ -0,0 +1,10 @@
+require 'connector_kit/models/app'
+
+module ConnectorKit
+  # Mapper between a HTTParty response and a list of Apps
+  class AppResponseMapper
+    def map(data)
+        App.new(data)
+    end
+  end
+end

data/lib/connector_kit/mappers/app_version_mapper.rb

@@ -0,0 +1,10 @@
+require 'connector_kit/models/version'
+
+module ConnectorKit
+
+  class VersionResponseMapper
+    def map(data)
+        data.map { |version| Version.new(version) }
+    end
+  end
+end

data/lib/connector_kit/mappers/build_details_response_mapper.rb

@@ -0,0 +1,10 @@
+require 'connector_kit/models/build_details'
+
+module ConnectorKit
+  # Mapper between a HTTParty response and a BuildDetails object
+  class BuildDetailsResponseMapper
+    def map(data)
+      BuildDetails.new(data)
+    end
+  end
+end

data/lib/connector_kit/mappers/build_list_response_mapper.rb

@@ -0,0 +1,10 @@
+require 'connector_kit/models/build'
+
+module ConnectorKit
+  # Mapper between a HTTParty response and a list of Builds
+  class BuildListResponseMapper
+    def map(data)
+      data.map { |build| Build.new(build) }
+    end
+  end
+end

data/lib/connector_kit/mappers/user_list_response_mapper.rb

@@ -0,0 +1,10 @@
+require 'connector_kit/models/user'
+
+module ConnectorKit
+  # Mapper between a HTTParty response and a list of Users
+  class UserListResponseMapper
+    def map(data)
+      data.map { |user| User.new(user) }
+    end
+  end
+end

data/lib/connector_kit/models/app.rb

@@ -0,0 +1,17 @@
+require 'connector_kit/models/model'
+
+module ConnectorKit
+  # Simple model class for representing Apps
+  class App < Model
+    attr_reader :bundle_id, :name, :sku
+
+    def initialize(options)
+      super(options)
+
+      attrs = options['attributes']
+      @bundle_id = attrs['bundleId']
+      @name = attrs['name']
+      @sku = attrs['sku']
+    end
+  end
+end

data/lib/connector_kit/models/build.rb

@@ -0,0 +1,23 @@
+require 'connector_kit/models/model'
+
+module ConnectorKit
+  # Simple model class for representing Builds
+  class Build < Model
+    attr_reader :expired,
+                :processing_state,
+                :version,
+                :uploaded_date,
+                :expiration_date
+
+    def initialize(options)
+      super(options)
+
+      attrs = options['attributes']
+      @expired = attrs['expired']
+      @processing_state = attrs['processingState']
+      @version = attrs['version']
+      @uploaded_date = Time.parse(attrs['uploadedDate']).getlocal
+      @expiration_date = Time.parse(attrs['expirationDate']).getlocal
+    end
+  end
+end

data/lib/connector_kit/models/build_details.rb

@@ -0,0 +1,16 @@
+require 'connector_kit/models/model'
+
+module ConnectorKit
+  # Simple model class for representing Build details
+  class BuildDetails < Model
+    attr_reader :external_build_state, :internal_build_state
+
+    def initialize(options)
+      super(options)
+
+      attrs = options['attributes']
+      @external_build_state = attrs['externalBuildState']
+      @internal_build_state = attrs['internalBuildState']
+    end
+  end
+end

data/lib/connector_kit/models/model.rb

@@ -0,0 +1,10 @@
+module ConnectorKit
+  # Base model for representing different entities
+  class Model
+    attr_reader :id
+
+    def initialize(options)
+      @id = options['id']
+    end
+  end
+end

data/lib/connector_kit/models/user.rb

@@ -0,0 +1,23 @@
+require 'connector_kit/models/model'
+
+module ConnectorKit
+  # Simple model class for representing Users in the App Store Connect API
+  class User < Model
+    attr_reader :first_name, :last_name, :username, :roles, :all_apps_visible
+
+    def initialize(options)
+      super(options)
+
+      attrs = options['attributes']
+      @first_name = attrs['firstName']
+      @last_name = attrs['lastName']
+      @username = attrs['username']
+      @all_apps_visible = attrs['allAppsVisible']
+      @roles = attrs['roles'].map { |role| role.downcase.to_sym }
+    end
+
+    def full_name
+      "#{@first_name} #{@last_name}"
+    end
+  end
+end

data/lib/connector_kit/models/version.rb

@@ -0,0 +1,16 @@
+require 'connector_kit/models/model'
+
+module ConnectorKit
+  # Simple model class for representing AppVersion
+  class Version < Model
+    attr_reader :version_string, :store_state
+
+    def initialize(options)
+      super(options)
+
+      attrs = options['attributes']
+      @version_string = attrs['versionString']
+      @store_state = attrs['appStoreState']
+    end
+  end
+end

data/lib/connector_kit/token_generator.rb

@@ -0,0 +1,35 @@
+require 'openssl'
+require 'jwt'
+
+module ConnectorKit
+  # Helper class for generating JWT tokens
+  class TokenGenerator
+
+    def self.cretat_from_file(issuer_id, key_id, private_key_file_path)
+      private_key = File.read(@private_key_file_path)
+      instance = TokenGenerator.new(issuer_id, key_id, private_key)
+    end
+
+    def initialize(issuer_id, key_id, private_key)
+      @private_key = private_key
+      @custom_headers = {
+        kid: key_id,
+        typ: 'JWT'
+      }
+      @payload = {
+        iss: issuer_id,
+        aud: 'appstoreconnect-v1'
+      }
+    end
+
+    def generate_token
+      ecdsa_key = OpenSSL::PKey.read(@private_key)
+      expiration = Time.now.to_i + 20 * 60
+      @payload[:exp] = expiration
+
+      puts "Generated token expires: #{Time.at(expiration)}"
+
+      JWT.encode(@payload, ecdsa_key, 'ES256', @custom_headers)
+    end
+  end
+end

data/lib/connector_kit/version.rb

@@ -0,0 +1,3 @@
+module ConnectorKit
+  VERSION = '0.3.1'.freeze
+end

data/spec/connector_kit_spec.rb

@@ -0,0 +1,9 @@
+RSpec.describe ConnectorKit do
+  it "has a version number" do
+    expect(ConnectorKit::VERSION).not_to be nil
+  end
+
+  it "does something useful" do
+    expect(false).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "connector_kit"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: connector_kit_fork
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Simon Jarbrant
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: A gem for communicating with the App Store Connect API.
+email:
+- simonjarbrant@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- connector_kit.gemspec
+- lib/connector_kit.rb
+- lib/connector_kit/exceptions.rb
+- lib/connector_kit/httpclient.rb
+- lib/connector_kit/mappers/app_list_response_mapper.rb
+- lib/connector_kit/mappers/app_response_mapper.rb
+- lib/connector_kit/mappers/app_version_mapper.rb
+- lib/connector_kit/mappers/build_details_response_mapper.rb
+- lib/connector_kit/mappers/build_list_response_mapper.rb
+- lib/connector_kit/mappers/user_list_response_mapper.rb
+- lib/connector_kit/models/app.rb
+- lib/connector_kit/models/build.rb
+- lib/connector_kit/models/build_details.rb
+- lib/connector_kit/models/model.rb
+- lib/connector_kit/models/user.rb
+- lib/connector_kit/models/version.rb
+- lib/connector_kit/token_generator.rb
+- lib/connector_kit/version.rb
+- spec/connector_kit_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/simba909/connector_kit
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A gem for communicating with the App Store Connect API.
+test_files:
+- spec/connector_kit_spec.rb
+- spec/spec_helper.rb