appveyor-api 0.0.1

data/README.md

@@ -0,0 +1,26 @@
+[![CircleCI](https://circleci.com/gh/damacus/appveyor-api/tree/master.svg?style=svg)](https://circleci.com/gh/damacus/appveyor-api/tree/master)
+
+# appveyor-api
+A wrapper for the AppVeyor API
+
+Inspiration from https://github.com/esaio/esa-ruby
+
+# Example Usage
+This client will accept either an `APPVEYOR_API_KEY` as an argument or detect an environment variable
+
+### Environment Variable
+`$APPVEYOR_API_KEY`
+
+### Access_token
+`@client = AppVeyor::Client.new(access_token:'123456787980nthrthrt)`
+
+## List Environments
+`@client.list_environments`
+
+## List Projects
+`@client.list_projects`
+
+## Update Environment
+`awesome_environment={"deploymentEnvironmentId":12168,"name":"production","provider":"FTP","settings":{"providerSettings":[{"name":"server","value":{"value":"ftp.server.com","isEncrypted":false}},{"name":"username","value":{"value":"ftp-user","isEncrypted":false}},{"name":"password","value":{"value":"password","isEncrypted":true}}],"environmentVariables":[{"name":"my-var","value":{"value":"123","isEncrypted":false}}]}}`
+
+`@client.create_environment(awesome_environment)`

data/appveyor.gemspec

@@ -0,0 +1,37 @@
+
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'appveyor-api'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Dan Webb']
+  spec.email         = ['dan.webb@damacus.io']
+  spec.summary       = 'Gem to wrap AppVeyor API'
+  spec.description   = 'Gem to wrap AppVeyor API for simpler interactions with the AppVeyor Api'
+  spec.homepage      = 'https://github.com/damacus/appveyor-api'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~>1.12'
+  spec.add_development_dependency 'rake', '~> 11.3'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.1'
+  spec.add_development_dependency 'rb-readline', '~> 0.5'
+  spec.add_development_dependency 'growl', '~> 1.0'
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2'
+
+  spec.add_dependency 'faraday', '~> 0.9.2'
+  spec.add_dependency 'faraday_middleware', '~> 0.10.0'
+  spec.add_dependency 'json', '~> 2.0'
+end

data/lib/appveyor-api.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+require 'appveyor-api/client'

data/lib/appveyor-api/build.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# Build
+def start_build
+  #   {
+  #     accountName: 'your-account-name',
+  #     projectSlug: 'project-slug-from-url',
+  #     branch: 'master',
+  #     environmentVariables: {
+  #        my_var: 'value',
+  #        another_var: 'another value'
+  #     }
+  # }
+end
+
+def start_commit_build
+  #   {
+  #     accountName: 'your-account-name',
+  #     projectSlug: 'project-slug-from-url',
+  #     branch: 'develop',
+  #     commitId: '3e9d9468'
+  # }
+end
+
+def start_pull_request_build
+  #   {
+  #     accountName: 'your-account-name',
+  #     projectSlug: 'project-slug-from-url',
+  #     pullRequestId: 3
+  # }
+end
+
+def cancel_build
+  # DELETE /api/builds/{accountName}/{projectSlug}/{buildVersion}
+end

data/lib/appveyor-api/client.rb

@@ -0,0 +1,78 @@
+
+# frozen_string_literal: true
+require 'appveyor-api/environments'
+require 'appveyor-api/projects'
+require 'appveyor-api/response'
+
+module AppVeyor
+  # Main client object that you interactive with AppVeyor via
+  #
+  # == Parameters:
+  #
+  # == Use:
+  # @client = AppVeyor::Client.new
+  # @client.find_by_name('dev')
+  #
+  class Client
+    include Environments
+    include Projects
+
+    def initialize(access_token: nil)
+      @access_token = access_token
+    end
+
+    def send_get(path, params = nil, headers = nil)
+      send_request(:get, path, params, headers)
+    end
+
+    def send_post(path, params = nil, headers = nil)
+      send_request(:post, path, params, headers)
+    end
+
+    def send_put(path, params = nil, headers = nil)
+      send_request(:put, path, params, headers)
+    end
+
+    def send_delete(path, params = nil, headers = nil)
+      send_request(:delete, path, params, headers)
+    end
+
+    def send_request(method, path, params = nil, headers = nil)
+      AppVeyor::Response.new(appveyor_connection.send(method, path, params, headers))
+    end
+
+    def appveyor_connection
+      @appveyor_connection ||= Faraday.new(faraday_options) do |c|
+        c.request :json
+        c.response :json
+        c.adapter Faraday.default_adapter
+      end
+    end
+
+    def faraday_options
+      {
+        url:     faraday_url,
+        headers: faraday_headers
+      }
+    end
+
+    def default_headers
+      {
+        'Accept'        => 'application/json',
+        'Authorization' => "Bearer #{access_token}"
+      }
+    end
+
+    def faraday_headers
+      default_headers
+    end
+
+    def access_token
+      @access_token || ENV['APPVEYOR_API_KEY']
+    end
+
+    def faraday_url
+      @api_endpoint ||= 'https://ci.appveyor.com'
+    end
+  end
+end

data/lib/appveyor-api/collaborators.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# Collaborators
+
+def get_collaborators(config)
+  # HTTParty.get('https://ci.appveyor.com/api/collaborators',
+  #              headers: { 'Authorization' => "Bearer  #{config.api_token}" })
+end
+
+def get_collaborator(config, _user_id)
+  # HTTParty.get("https://ci.appveyor.com/api/collaborator/#{userId}",
+  #              headers: { 'Authorization' => "Bearer  #{config.api_token}" })
+end
+
+def add_collaborator
+end
+
+def update_collaborator
+end
+
+def delete_collaborator
+end

data/lib/appveyor-api/deployment.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# Deployment
+def get_deployment(_config, _deployment_id)
+end
+
+def start_deployment(config)
+  # body = {
+  #   environmentName: 'psm-archive-production',
+  #   accountName: 'js-devops',
+  #   projectSlug: 'psm-archive',
+  #   buildVersion: '1.0.269'
+  # }
+  # response = HTTParty.post('https://ci.appveyor.com/api/deployments',
+  #                          body: body.to_json,
+  #                          headers: { 'Authorization' => "Bearer #{config.api_token}",
+  #                                     'Content-Type' => 'application/json',
+  #                                     'Accept' => 'application/json' })
+  #
+  # puts response.code
+end
+
+# def start_deployment(config)
+#   conn = Faraday.new(:url => 'http://sushi.com') do |faraday|
+#     faraday.request  :url_encoded             # form-encode POST params
+#     faraday.response :logger                  # log requests to STDOUT
+#     faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+#   end
+# end
+
+def start_deploy(api_token)
+  # body = {
+  #   environmentName: environment_name,
+  #   accountName: account_name,
+  #   projectSlug: project_slug,
+  #   buildVersion: build_version
+  # }
+  # response = HTTParty.post('https://ci.appveyor.com/api/deployments',
+  #                          body: body.to_json,
+  #                          headers: { 'Authorization' => "Bearer #{api_token}",
+  #                                     'Content-Type' => 'application/json',
+  #                                     'Accept' => 'application/json'
+  #                                     })
+end
+
+def cancel_deployment(_config, _deployment_id)
+  # /api/deployments/stop
+end

data/lib/appveyor-api/environments.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+require 'faraday'
+require 'json'
+
+# Wrapper around the Environment object
+# Used for searching for environments
+#
+# == Parameters:
+# name
+#   A String containing the environment you are looking for
+#
+# == Returns:
+# An environment
+#
+module AppVeyor
+  #
+  #
+  module Environments
+    # returns Environments hash
+    def environment_list
+      envs_list = send_get('/api/environments').body
+      envs_hash = {}
+      (0..envs_list.length - 1).each do |e|
+        envs_hash.store(envs_list[e]['deploymentEnvironmentId'], envs_list[e]['name'])
+      end
+      envs_hash
+    end
+
+    def find_by_name(name)
+      found_environment = {}
+      found_environment = environment_list.select { |key, val| val == name }
+      raise 'Multiple Environments found during search' if found_environment.length > 1
+
+      environment = send_get("/api/environments/#{found_environment.keys.first}/settings")
+      AppVeyor::Environment.new(environment.body['environment'])
+    end
+
+    def find_by_id(id)
+      environment = send_get("/api/environments/#{id}/settings")
+      AppVeyor::Environment.new(environment.body['environment'])
+    end
+
+    def create_environment(environment)
+      env = send_post('/api/environments', environment)
+      AppVeyor::Environment.new(env.body['environment'])
+    end
+
+    def update_environment(environment)
+      env = send_put('/api/environments', environment)
+      AppVeyor::Environment.new(env.body)
+    end
+
+    def delete_environment(environment_id)
+      send_delete("/api/environments/#{environment_id}")
+    end
+  end
+end
+# The environment object as per the AppVeyor API documentation
+# https://www.appveyor.com/docs/api/environments-deployments/
+# CRUD actions for an environment
+#
+# == Parameters:
+# deployment_environment_id:
+# projects_mode:
+# account_id
+# name:
+# settings
+# => provider_settings: array of settings
+#    [{"name"=>"test_setting",
+#      "value"=>{"isEncrypted"=>false,
+#      "value"=>"myaccount"}}]
+
+module AppVeyor
+  # == Returns:
+  # An environment object
+  #
+  class Environment
+    def initialize(options = {})
+      options.each { |k, v| public_send("#{k}=", v) } if options
+    end
+
+    def id
+      @deploymentEnvironmentId
+    end
+
+    def deployment_environment_id
+      @deploymentEnvironmentId
+    end
+
+    def account_id
+      @accountId
+    end
+
+    def projects_mode
+      @projectsMode
+    end
+
+    def selected_projects
+      @selectedProjects
+    end
+
+    attr_accessor :deploymentEnvironmentId
+    attr_accessor :accountId
+    attr_accessor :name
+    attr_accessor :provider
+    attr_accessor :projectsMode
+    attr_accessor :created
+    attr_accessor :updated
+    attr_accessor :settings
+    attr_accessor :provider_settings
+    attr_accessor :environmentAccessKey
+    attr_accessor :selectedProjects
+    attr_accessor :projects
+    attr_accessor :securityDescriptor
+  end
+end

data/lib/appveyor-api/projects.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module AppVeyor
+  module Projects
+    def get_project_last_build(config)
+      # response = HTTParty.get("https://ci.appveyor.com/api/projects/#{config.account}/#{config.project}",
+      #                         headers: { 'Authorization' => "Bearer #{config.api_token}" })
+      # response['build']['message']
+    end
+
+    def list_projects()
+      projects_list = send_get('/api/projects').body
+      projects_hash = {}
+      (0..projects_list.length - 1).each do |x|
+        projects_hash.store(projects_list[x]['projectId'], projects_list[x]['name'])
+      end
+      projects_hash
+    end
+  end
+
+  class Project
+    def initialize(options = {})
+      options.each { |k, v| public_send("#{k}=", v) } if options
+    end
+    attr_accessor :projectId
+    attr_accessor :accountId
+    attr_accessor :accountName
+    attr_accessor :builds
+    attr_accessor :name
+    attr_accessor :slug
+    attr_accessor :repositoryType
+    attr_accessor :repositoryScm
+    attr_accessor :repositoryName
+    attr_accessor :repositoryBranch
+    attr_accessor :isPrivate
+    attr_accessor :skipBranchesWithoutAppveyorYml
+    attr_accessor :enableSecureVariablesInPullRequests
+    attr_accessor :enableSecureVariablesInPullRequestsFromSameRepo
+    attr_accessor :enableDeploymentInPullRequests
+    attr_accessor :rollingBuilds
+    attr_accessor :alwaysBuildClosedPullRequests
+    attr_accessor :tags
+    attr_accessor :nuGetFeed
+    attr_accessor :securityDescriptor
+    attr_accessor :created
+    attr_accessor :updated
+
+    def project_id
+      @projectId
+    end
+
+    def account_id
+      @accountId
+    end
+
+    def project_name
+      @name
+    end
+
+    def account_name
+      @accountName
+    end
+
+    def repository_type
+      @repositoryType
+    end
+
+    def repository_scm
+      @repositoryScm
+    end
+
+    def repository_name
+      @repositoryName
+    end
+
+    def repository_branch
+      @repositoryBranch
+    end
+
+    def isPrivate
+      @isPrivate
+    end
+
+    def skip_branches_without_appveyor_yml
+      @skipBranchesWithoutAppveyorYml
+    end
+
+    def enable_secure_variables_in_pull_requests
+      @enableSecureVariablesInPullRequests
+    end
+
+    def enable_secure_variables_in_pull_requests_from_same_repo
+      @enableSecureVariablesInPullRequestsFromSameRepo
+    end
+
+    def enbale_deployment_in_pull_requests
+      @enableDeploymentInPullRequests
+    end
+
+    def rolling_builds
+      @rollingBuilds
+    end
+
+    def always_build_closed_pull_requests
+      @alwaysBuildClosedPullRequests
+    end
+
+    def nuget_feed
+      @nuGetFeed
+    end
+
+    def security_descriptor
+      @securityDescriptor
+    end
+  end
+end