connector_kit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb10df7a59883472f2597ad2d3fa5b67c5e236afaf31cd967334e56afe545990
-  data.tar.gz: 5f5a13651901a653afa50b59d26ecff458cda485d70dc3ef54eb721c3b0f2e37
+  metadata.gz: '08bee81ea565559ab0b8e5156e8149c00d42c75a16006ac8286b8d9e9caf91aa'
+  data.tar.gz: 4f5ca61f4feac8042d710debefed0db9ed857c389d5ee1b22bb81d67966fdd5c
 SHA512:
-  metadata.gz: d2bb1ab2ddfb07d84257d132de77d90026757ff651fff907bd18a255db7666dda70c01ad2b298d428fd9ff4ed94f52d37342709a4bf95c88bf625b31a95ebbba
-  data.tar.gz: 481972d2871a8141fd3a800c51f091b2185e3140fb127cb1336a95f8c339265d26e4627d21b5600c73d43b3a99a6bfd8f4738d9f21a12f0c0bd62389c62888f5
+  metadata.gz: f0ed6058f0cea7ad567120bb4a5c75463134cc8e3b19790a931f06ac7fc9209d59d02686ad72a5e4dcc0f4a70370a04b687bb07e3ac7c59ae8c4815afe1c6434
+  data.tar.gz: fb0c640fc46f104d502f856efc9ab4d736b06f6610dba75eb6f6ef63e6e5b2889382e1030a21f63450c4df4cdf6cb7f0081c8cf69066009fb2f04ed87dadb2f6

data/README.md

@@ -1,8 +1,8 @@
-# ConnectorKit
+# ConnectorKit 🔌
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/connector_kit`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/connector_kit.svg)](https://badge.fury.io/rb/connector_kit)
 
-TODO: Delete this and the text above, and describe your gem
+A simple Ruby gem for communicating with the [App Store Connect API](https://developer.apple.com/app-store-connect/api).
 
 ## Installation
 
@@ -14,15 +14,52 @@ gem 'connector_kit'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install connector_kit
+```bash
+$ gem install connector_kit
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+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
 
@@ -32,7 +69,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/connector_kit.
+Bug reports and pull requests are welcome on GitHub at https://github.com/simba909/connector_kit.
 
 ## License
 

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/models/build.rb

@@ -15,8 +15,8 @@ module ConnectorKit
       @expired = attrs['expired']
       @processing_state = attrs['processingState']
       @version = attrs['version']
-      @uploaded_date = Time.parse(attrs['uploadedDate'])
-      @expiration_date = Time.parse(attrs['expirationDate'])
+      @uploaded_date = Time.parse(attrs['uploadedDate']).getlocal
+      @expiration_date = Time.parse(attrs['expirationDate']).getlocal
     end
   end
 end

data/lib/connector_kit/version.rb

@@ -1,3 +1,3 @@
 module ConnectorKit
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'.freeze
 end

data/lib/connector_kit.rb

@@ -1,18 +1,13 @@
-require 'httparty'
-
+require 'connector_kit/httpclient.rb'
 require 'connector_kit/token_generator'
-require 'connector_kit/exceptions'
 require 'connector_kit/version'
 require 'connector_kit/mappers/app_list_mapper'
 require 'connector_kit/mappers/build_list_mapper'
 require 'connector_kit/mappers/build_details_mapper'
 
 module ConnectorKit
-  # Client class used for communicating with the App Store Connect API
+  # Class used for communicating with the App Store Connect API
   class Client
-    include HTTParty
-    base_uri 'https://api.appstoreconnect.apple.com/v1'
-
     def initialize(issuer_id, key_id, private_key_file_path)
       token_generator = TokenGenerator.new(
         issuer_id,
@@ -20,37 +15,22 @@ module ConnectorKit
         private_key_file_path
       )
 
-      self.class.headers(
+      @httpclient = HTTPClient.new('https://api.appstoreconnect.apple.com/v1')
+      @httpclient.class.headers(
         'Authorization' => "Bearer #{token_generator.generate_token}"
       )
     end
 
     def apps
-      get '/apps', AppListMapper.new
+      @httpclient.get '/apps', AppListMapper.new
     end
 
     def app_builds(app)
-      get "/apps/#{app.id}/builds", BuildListMapper.new
+      @httpclient.get "/apps/#{app.id}/builds", BuildListMapper.new
     end
 
     def build_beta_details(build)
-      get "/buildBetaDetails/#{build.id}", BuildDetailsMapper.new
-    end
-
-    private
-
-    def get(url, mapper)
-      response = self.class.get(url)
-
-      raise make_api_error(response) unless response.code == 200
-
-      mapper.map(response.parsed_response['data'])
-    end
-
-    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'])
+      @httpclient.get "/buildBetaDetails/#{build.id}", BuildDetailsMapper.new
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: connector_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Simon Jarbrant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -107,6 +107,7 @@ files:
 - connector_kit.gemspec
 - lib/connector_kit.rb
 - lib/connector_kit/exceptions.rb
+- lib/connector_kit/httpclient.rb
 - lib/connector_kit/mappers/app_list_mapper.rb
 - lib/connector_kit/mappers/build_details_mapper.rb
 - lib/connector_kit/mappers/build_list_mapper.rb