bitrise-client 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba17bd32401a009fcfce53e1aea475ab478fcb3409facfe3f5ea60a1473b4703
-  data.tar.gz: e3cefe0df76ca123b9978ac4935cad2df085f78e421c801507b367facefc7f83
+  metadata.gz: b7821748e7f74345830c188a95a15773c11d839e6b2d66357f6d1d581e3beb5d
+  data.tar.gz: 595fc5c50c502a0918a48f4687efceb24614e5a82245dad71df149a3754ac9bf
 SHA512:
-  metadata.gz: f9a93ee147c25b5fa3951691f262dd826dbc4c7bb8897ca581d654196dc563b0c8ff47544c489eb38acaa9fbfeed8f2a0cbd5e13947d6b225e9ff980b6a2a4cf
-  data.tar.gz: 9bbff68c08ae6ee968560a17be4f258c24b4946271274eed9439862472d72d37bb6013d7d90b848be1995d735994fddef98d739d61018558cb7b9413940b813b
+  metadata.gz: 8f6ae368b2311fbebb562524c70ff98e264325281d3eceb7e9bc9da1e4969667f5f0cff52996d980ee4a00d2a657752261eef445b50a0c75924e2804264a2eb6
+  data.tar.gz: cee9d446ca68da58390492ba316734e4f626638204497ccbda6ae7481b77d75e99569536b42056a67e0c6f5cbbb99f7f4f9efbea86fc894bea9adf17f9f8c69c

data/.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [head, 3.0, 2.7]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -11,3 +11,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## v0.3.1
+
+Add GET apps. - [@tomorrowkey](https://github.com/tomorrowkey) [#6](https://github.com/mataku/bitrise-client/pull/6)
+
+## v0.3.0
+
+Lock faraday version to 1.X because `Faraday::Response::Middleware` is deleted in faraday 2. - [@tomorrowkey](https://github.com/tomorrowkey) [#5](https://github.com/mataku/bitrise-client/pull/5) 
+
+## v0.2.0
+
+Changed to use the [Bitrise v0.1 API](https://devcenter.bitrise.io/en/api.html), so you need to change to specify an access token to bitrise-client initialization. See: https://github.com/mataku/bitrise-client#usage
+
+- Support endpoint for triggering a build
+- Support aborting a build
+- Support listing registered test devices of all members of a specified Bitrise app
+
+## v0.1.0
+
+Released.
+
+- Support triggering a build

data/README.md

@@ -2,7 +2,11 @@
 
 A ruby client for [Bitrise API](https://devcenter.bitrise.io/#bitrise-api).
 
-Now supports [Build Trigger API](https://devcenter.bitrise.io/api/build-trigger/) only.
+Now supports following APIs.
+
+- [Build Trigger](https://devcenter.bitrise.io/api/build-trigger/)
+- [Get Test Devices](https://devcenter.bitrise.io/en/api/api-reference.html#operations-tag-test-devices)
+- [Get Apps](https://devcenter.bitrise.io/en/api/api-reference.html)
 
 ## Installation
 
@@ -25,19 +29,52 @@ Or install it yourself as:
 ```ruby
 require 'bitrise'
 
-client = Bitrise::Client.new
-client.trigger_build(
-  app_slug = 'your_app_slug', # required
-  build_trigger_token = 'your_build_trigger_token', # required
+# Access token required to use bitrise v0.1 API. See: https://devcenter.bitrise.io/en/api/authenticating-with-the-bitrise-api.html
+client = Bitrise::Client.new(access_token: 'your access token')
+
+# Trigger a build
+result = client.trigger_build(
+  app_slug: 'your_app_slug', # Required
   build_params: {
-    # A tag, branch or workflow_id parameter required
+    # At least a tag, branch or workflow_id parameter required so that Bitrise can identify which workflow to run
     branch: 'branch',
     tag:    'tag',
     workflow_id: 'workflow_id'
   }
 )
+
+p result.build_url # => "https://app.bitrise.io/build/1234abcd5678efgh"
+
+# Abort a build
+client.abort_build(
+  # Required
+  app_slug: 'your_app_slug',
+  # Required
+  build_slug: 'build slug to abort',
+
+  # Optional
+  options: {
+    abort_reason: 'wanna relax', # You can set a reason
+    abort_with_success: true,    # Set true if you want to treat as a successful
+    skip_notifications: true     # Set true if you want to receive notification even if your notification setting in app is off
+  }
+)
+
+# List registered test devices of all members of a specified Bitrise app
+devices = client.test_devices(
+  # Required
+  app_slug: 'your_app_slug'
+)
+devices.each do |device|
+  p device.device_id
+  p device.device_type
+  p device.owner
+end
 ```
 
+## Changelog
+
+See [CHANGELOG.md](/CHANGELOG.md)
 
 ## License
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "bitrise/client"
+require "bitrise"
 
 # 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.

data/bitrise-client.gemspec

@@ -35,10 +35,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'faraday', '~> 0.9'
+  spec.add_runtime_dependency 'faraday', '~> 1'
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "irb"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
 end

data/lib/bitrise/app.rb

@@ -0,0 +1,34 @@
+require "bitrise/response"
+require "bitrise/app_owner"
+
+module Bitrise
+  class AppResponse < Response
+    include Pagination
+
+    def data
+      @json.fetch("data")&.map do |raw|
+        App.new(raw)
+      end
+    end
+  end
+
+  class App
+    attr_reader :slug, :title, :project_type, :provider, :repo_owner, :repo_url, :repo_slug, :is_disabled, :status, :is_public, :is_github_checks_enabled, :owner, :avatar_url
+
+    def initialize(attrs = {})
+      @slug = attrs['slug']
+      @title = attrs['title']
+      @project_type = attrs['project_type']
+      @provider = attrs['provider']
+      @repo_owner = attrs['repo_owner']
+      @repo_url = attrs['repo_url']
+      @repo_slug = attrs['repo_slug']
+      @is_disabled = attrs['is_disabled']
+      @status = attrs['status']
+      @is_public = attrs['is_public']
+      @is_github_checks_enabled = attrs['is_github_checks_enabled']
+      @owner = AppOwner.new(attrs['owner'])
+      @avatar_url = attrs['avatar_url']
+    end
+  end
+end

data/lib/bitrise/app_owner.rb

@@ -0,0 +1,11 @@
+module Bitrise
+  class AppOwner
+    attr_reader :account_type, :name, :slug
+
+    def initialize(attrs = {})
+      @account_type = attrs['account_type']
+      @name = attrs['name']
+      @slug = attrs['slug']
+    end
+  end
+end

data/lib/bitrise/build_trigger_result.rb

@@ -0,0 +1,15 @@
+module Bitrise
+  class BuildTriggerResult
+    attr_accessor :build_number, :build_slug, :build_url, :message, :service, :slug, :status, :triggered_workflow
+    def initialize(attrs = {})
+      @build_number = attrs['build_number']
+      @build_slug = attrs['build_slug']
+      @build_url = attrs['build_url']
+      @message = attrs['message']
+      @service = attrs['service']
+      @slug = attrs['slug']
+      @status = attrs['status']
+      @triggered_workflow = attrs['triggered_workflow']
+    end
+  end
+end

data/lib/bitrise/client/app.rb

@@ -0,0 +1,32 @@
+require 'bitrise/app'
+require 'json'
+
+module Bitrise
+  class Client
+    module App
+
+      # List all the apps available for the authenticated account, including those that are owned by other users or Organizations.
+      #
+      # @param sort_by [String] Order of the applications: sort them based on when they were created or the time of their last build
+      #   Available values : last_build_at, created_at
+      # @param next [String] Slug of the first app in the response
+      # @param limit [Integer] Max number of elements per page (default: 50)
+      #
+      # @return [App]
+      def apps(sort_by: nil, _next: nil, limit: nil)
+        response = client.get do |request|
+          request.url "/v0.1/apps"
+          request.params = {
+            sort_by: sort_by,
+            next: _next,
+            limit: limit,
+          }.compact
+          request.headers['Content-Type'] = 'application/json'
+        end
+
+        result = JSON.parse(response.body)
+        AppResponse.new(result)
+      end
+    end
+  end
+end

data/lib/bitrise/client/build.rb

@@ -1,43 +1,56 @@
+require 'bitrise/build_trigger_result'
 require 'json'
 
 module Bitrise
   class Client
     module Build
-      
       # Trigger a build of your bitrise app
       #
       # @param app_slug [String] Your bitrise app slug
-      # @param build_trigger_token [String] Build Trigger token of your app
-      # 
-      # See: https://devcenter.bitrise.io/api/build-trigger/
-      def trigger_build(app_slug = nil, build_trigger_token = nil, options = {})
-        @app_slug = app_slug || raise('App slug required.')
-        @build_trigger_token = build_trigger_token || raise('Build trigger token required.')
+      # @param build_params [Hash] Bulld params so that Bitrise can identify which workflow to run. Specify a branch or tag or workflow_id at least.
+      #
+      # @return [Bitrise::BuildTriggerResult]
+      #
+      # See: https://devcenter.bitrise.io/en/api/triggering-and-aborting-builds.html#triggering-a-new-build-with-the-api
+      def trigger_build(app_slug: nil, build_params: {})
+        raise ArgumentError, 'App slug required. You must specify by \'app_slug:\'' unless app_slug
+        raise ArgumentError, 'No value found for \'branch\' or \'tag\' or \'workflow_id\'' if build_params.empty?
 
         response = client.post do |request|
-          request.url "/app/#{@app_slug}/build/start.json"
+          request.url "/v0.1/apps/#{app_slug}/builds"
           request.headers['Content-Type'] = 'application/json'
           request.body = {
             hook_info: {
-              type: 'bitrise',
-              build_trigger_token: @build_trigger_token
+              type: 'bitrise'
             },
-            build_params: options[:build_params]
+            build_params: build_params
           }.to_json
         end
 
-        check_http_status(response)
-
-        JSON.parse(response.body)
+        result = JSON.parse(response.body)
+        BuildTriggerResult.new(result)
       end
+    end
 
-      def check_http_status(response)
-        case response.status
-        when 200..299 then
-          return
-        else
-          raise JSON.parse(response.body)['message']
-        end
+    # Abort a build of your bitrise app
+    #
+    # @param app_slug [String] Your bitrise app slug
+    # @param build_slug [String] Bitrise build slug which you want to abort
+    #
+    # @param options [Hash]
+    # @option opts [String]  :abort_reason        A reason for aborting the build
+    # @option opts [Boolean] :abort_with_success  Treat as a successful or not
+    # @option opts [Boolean] :skip_notifications  Set true if you want to send email notifications about aborting by Bitrise
+    #
+    # See: https://devcenter.bitrise.io/en/api/triggering-and-aborting-builds.html#aborting-a-build
+    def abort_build(app_slug: nil, build_slug: nil, options: {})
+      raise ArgumentError, 'App slug required. You must specify by \'app_slug:\'' unless app_slug
+      raise ArgumentError, 'Build slug required. You must specify by \'build_slug:\'' unless build_slug
+
+      client.post do |request|
+        request.url "/v0.1/apps/#{app_slug}/builds/#{build_slug}/abort"
+        request.headers['Content-Type'] = 'application/json'
+        request.body = options.to_json
       end
     end
   end

data/lib/bitrise/client/middleware/error_handler.rb

@@ -0,0 +1,20 @@
+require 'faraday'
+require 'bitrise/error'
+
+module Bitrise
+  class Client
+    module Middleware
+
+      class ErrorHandler < Faraday::Response::Middleware
+
+      # @param [Faraday::Response]
+        def on_complete(response)
+          case response.status
+          when 400..599
+            raise Bitrise::Error.new(JSON.parse(response.body)['message'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bitrise/client/test_device.rb

@@ -0,0 +1,28 @@
+require 'bitrise/test_device'
+require 'json'
+
+
+module Bitrise
+  class Client
+    module TestDevice
+
+      # List registered test devices of all members of a specified Bitrise app
+      #
+      # @param app_slug [String] Your bitrise app slug
+      #
+      # @return [Array<Bitrise::TestDevice>
+      def test_devices(app_slug: nil)
+        raise ArgumentError, 'App slug required. You must specify by \'app_slug:\'' unless app_slug
+
+        response = client.get do |request|
+          request.url "/v0.1/apps/#{app_slug}/test-devices"
+          request.headers['Content-Type'] = 'application/json'
+        end
+
+        JSON.parse(response.body)['data'].map do |device|
+          Bitrise::TestDevice.new(device)
+        end
+      end
+    end
+  end
+end

data/lib/bitrise/client/version.rb

@@ -1,5 +1,5 @@
 module Bitrise
   class Client
-    VERSION = "0.1.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/bitrise/client.rb

@@ -1,14 +1,25 @@
-require 'bitrise/client/build'
-require 'faraday'
+%w(
+  bitrise/client/app
+  bitrise/client/build
+  bitrise/client/test_device
+  bitrise/client/middleware/error_handler
+  faraday
+).each do |lib|
+  require lib
+end
 
 module Bitrise
   class Client
+    include Bitrise::Client::App
     include Bitrise::Client::Build
+    include Bitrise::Client::TestDevice
 
-    def initialize(options = {})
-      @api_host = options[:host] || 'https://app.bitrise.io'
+    def initialize(access_token: nil, options: {})
+      raise ArgumentError.new('You must specify Bitrise access token by `access_token:`.') unless access_token
+      @api_host = options[:host] || 'https://api.bitrise.io'
       @timeout = options[:timeout] || 30
       @open_timeout = options[:open_timeout] || 30
+      @access_token = access_token
     end
 
     def client
@@ -16,7 +27,9 @@ module Bitrise
         faraday.options.timeout        = @timeout
         faraday.options.open_timeout   = @open_timeout
         faraday.options.params_encoder = Faraday::FlatParamsEncoder
+        faraday.use Bitrise::Client::Middleware::ErrorHandler
         faraday.response :logger if ENV['DEBUG']
+        faraday.headers['Authorization'] = @access_token
 
         faraday.adapter Faraday.default_adapter
       end

data/lib/bitrise/error.rb

@@ -0,0 +1,5 @@
+module Bitrise
+  class Error < StandardError
+
+  end
+end

data/lib/bitrise/response.rb

@@ -0,0 +1,23 @@
+module Bitrise
+  class Response
+    def initialize(json)
+      @json = json
+    end
+  end
+
+  class Paging
+    attr_reader :total_item_count, :page_item_limit, :next
+
+    def initialize(attrs = {})
+      @total_item_count = attrs['total_item_count']
+      @page_item_limit = attrs['page_item_limit']
+      @next = attrs['next']
+    end
+  end
+
+  module Pagination
+    def paging
+      ::Bitrise::Paging.new(@json["paging"])
+    end
+  end
+end

data/lib/bitrise/test_device.rb

@@ -0,0 +1,11 @@
+module Bitrise
+  class TestDevice
+    attr_accessor :device_id, :device_type, :owner
+
+    def initialize(attrs = {})
+      @device_id = attrs['device_id']
+      @device_type = attrs['device_type']
+      @owner = attrs['owner']
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitrise-client
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.1
 platform: ruby
 authors:
 - mataku
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2022-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
 description: A ruby client for Bitrise API
 email:
 - nagomimatcha@gmail.com
@@ -87,9 +101,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -98,9 +113,18 @@ files:
 - bin/setup
 - bitrise-client.gemspec
 - lib/bitrise.rb
+- lib/bitrise/app.rb
+- lib/bitrise/app_owner.rb
+- lib/bitrise/build_trigger_result.rb
 - lib/bitrise/client.rb
+- lib/bitrise/client/app.rb
 - lib/bitrise/client/build.rb
+- lib/bitrise/client/middleware/error_handler.rb
+- lib/bitrise/client/test_device.rb
 - lib/bitrise/client/version.rb
+- lib/bitrise/error.rb
+- lib/bitrise/response.rb
+- lib/bitrise/test_device.rb
 homepage: https://github.com/mataku/bitrise-client
 licenses:
 - MIT
@@ -122,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A ruby clent for Bitrise API

data/.travis.yml

@@ -1,8 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.0
-script:
-  - bundle exec rspec spec