semaphoreci_api 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 642c9c6d80c2a3f692ae767fde541f2e9be6caea
+  data.tar.gz: f4030fffc7074657cd5dbab2caee0576d8c1b06a
+SHA512:
+  metadata.gz: 3c53c0957c336b2646ef62893b74c1bcc59cfc0db49c7ad214201e46a34752b4423bcc8013213178b930101fe34f69fdedd0f564669fc203ac1f1665eb5b7547
+  data.tar.gz: 42818913131d6220c44185eb304bd27377e7493f5cace474c74e7f087f53021dccb62cb6ba77714ad17490dbdb7b14c61c7566c896207eb79beb253c53561f69

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in semaphoreci_api.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# SemaphoreciApi
+
+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/semaphoreci_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'semaphoreci_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install semaphoreci_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/[USERNAME]/semaphoreci_api.
+

data/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+require 'yard'
+
+desc 'Generate API documentation'
+YARD::Rake::YardocTask.new
+
+desc 'Download the latest schema and build a new client'
+task :build do
+  sh 'curl -o schema.json http://api-docs.semaphoreci.com/schema.json'
+  sh 'bundle exec heroics-generate ./config/client-config.rb > lib/semaphoreci_api/client.rb'
+  sh 'rm schema.json'
+end
+
+desc 'Publish API documentation'
+task :publish do
+  sh 'rake yard'
+  sh 'cp -R doc /tmp/semaphoreci-api-doc'
+  sh 'git checkout gh-pages'
+  sh 'cp -R /tmp/semaphoreci-api-doc/* .'
+  sh 'rm -rf /tmp/semaphoreci-api-doc'
+  sh 'git add .'
+  sh 'git commit -am "Rebuild documentation"'
+  sh 'git push origin gh-pages'
+  sh 'git checkout master'
+end
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "semaphoreci_api"
+
+# 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

data/bin/setup

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

data/config/client-config.rb

@@ -0,0 +1,13 @@
+require 'heroics'
+
+Heroics.default_configuration do |config|
+  config.base_url = 'https://semaphoreci.com/api/v2'
+  config.module_name = 'SemaphoreciApi'
+  config.schema_filepath = 'schema.json'
+
+  config.headers = { 'Accept' => 'application/vnd.semaphoreci+json; version=1' }
+
+  # Note: Don't use doublequotes below -- we want to interpolate at runtime,
+  # not when the client is generated
+  config.cache_path = '#{Dir.home}/.heroics/example'
+end

data/lib/semaphoreci_api.rb

@@ -0,0 +1,10 @@
+require 'heroics'
+
+require_relative '../config/client-config'
+
+module SemaphoreciApi
+  # Your code goes here...
+end
+
+require 'semaphoreci_api/client'
+require 'semaphoreci_api/version'

data/lib/semaphoreci_api/client.rb

@@ -0,0 +1,478 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+#
+# WARNING: Do not edit by hand, this file was generated by Heroics:
+#
+#   https://github.com/interagent/heroics
+#
+
+require 'heroics'
+require 'uri'
+
+module SemaphoreciApi
+  # Get a Client configured to use HTTP Basic or header-based authentication.
+  #
+  # @param api_key [String] The API key to use when connecting.
+  # @param options [Hash<Symbol,String>] Optionally, custom settings
+  #   to use with the client.  Allowed options are `default_headers`,
+  #   `cache`, `user` and `url`.
+  # @return [Client] A client configured to use the API with HTTP Basic
+  #   or header-based authentication.
+  def self.connect(api_key, options=nil)
+    options = custom_options(options)
+    uri = URI.parse(options[:url])
+
+    if options[:user]
+      uri.user = URI.encode_www_form_component options[:user]
+    end
+
+    if api_key
+      uri.user ||= 'user'
+      uri.password = api_key
+    end
+
+    client = Heroics.client_from_schema(SCHEMA, uri.to_s, options)
+    Client.new(client)
+  end
+
+  # Get a Client configured to use OAuth authentication.
+  #
+  # @param oauth_token [String] The OAuth token to use with the API.
+  # @param options [Hash<Symbol,String>] Optionally, custom settings
+  #   to use with the client.  Allowed options are `default_headers`,
+  #   `cache` and `url`.
+  # @return [Client] A client configured to use the API with OAuth
+  #   authentication.
+  def self.connect_oauth(oauth_token, options=nil)
+    options = custom_options(options)
+    url = options[:url]
+    client = Heroics.oauth_client_from_schema(oauth_token, SCHEMA, url, options)
+    Client.new(client)
+  end
+
+  # Get a Client configured to use Token authentication.
+  #
+  # @param token [String] The token to use with the API.
+  # @param options [Hash<Symbol,String>] Optionally, custom settings
+  #   to use with the client.  Allowed options are `default_headers`,
+  #   `cache` and `url`.
+  # @return [Client] A client configured to use the API with OAuth
+  #   authentication.
+  def self.connect_token(token, options=nil)
+    options = custom_options(options)
+    url = options[:url]
+    client = Heroics.token_client_from_schema(token, SCHEMA, url, options)
+    Client.new(client)
+  end
+
+  # Get customized options.
+  def self.custom_options(options)
+    return default_options if options.nil?
+
+    final_options = default_options
+    if options[:default_headers]
+      final_options[:default_headers].merge!(options[:default_headers])
+    end
+    final_options[:cache] = options[:cache] || Moneta.new(:File, dir: "#{Dir.home}/.heroics/example")
+    final_options[:url] = options[:url] if options[:url]
+    final_options[:user] = options[:user] if options[:user]
+    final_options
+  end
+
+  # Get the default options.
+  def self.default_options
+    default_headers = {"Accept"=>"application/vnd.semaphoreci+json; version=1"}
+    {
+      default_headers: default_headers,
+      url:             "https://semaphoreci.com/api/v2"
+    }
+  end
+
+  private_class_method :default_options, :custom_options
+
+  # Semaphore
+  class Client
+    def initialize(client)
+      @client = client
+    end
+
+    # Get basic information about your organizations
+    #
+    # @return [Org]
+    def org
+      @org_resource ||= Org.new(@client)
+    end
+
+    # All aspects of team management
+    #
+    # @return [Team]
+    def team
+      @team_resource ||= Team.new(@client)
+    end
+  end
+
+  private
+
+  # Get basic information about your organizations
+  class Org
+    def initialize(client)
+      @client = client
+    end
+
+    # Info for existing organization.
+    #
+    # @param org_username: unique username of organization
+    def info(org_username)
+      @client.org.info(org_username)
+    end
+
+    # List existing organizations.
+    def list()
+      @client.org.list()
+    end
+  end
+
+  # All aspects of team management
+  class Team
+    def initialize(client)
+      @client = client
+    end
+
+    # Create a new team.
+    #
+    # @param org_username: unique username of organization
+    # @param body: the object to pass as the request payload
+    def create(org_username, body = {})
+      @client.team.create(org_username, body)
+    end
+
+    # Delete an existing team.
+    #
+    # @param team_id: unique identifier of team
+    def delete(team_id)
+      @client.team.delete(team_id)
+    end
+
+    # Info for existing team.
+    #
+    # @param team_id: unique identifier of team
+    def info(team_id)
+      @client.team.info(team_id)
+    end
+
+    # List existing teams for an org.
+    #
+    # @param org_username: unique username of organization
+    def list(org_username)
+      @client.team.list(org_username)
+    end
+
+    # Update an existing team.
+    #
+    # @param team_id: unique identifier of team
+    # @param body: the object to pass as the request payload
+    def update(team_id, body = {})
+      @client.team.update(team_id, body)
+    end
+  end
+
+  SCHEMA = Heroics::Schema.new(MultiJson.load(<<-'HEROICS_SCHEMA'))
+{
+  "$schema": "http://interagent.github.io/interagent-hyper-schema",
+  "type": [
+    "object"
+  ],
+  "definitions": {
+    "org": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "title": "Organizations",
+      "description": "Get basic information about your organizations",
+      "stability": "prototype",
+      "strictProperties": true,
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "id": {
+          "description": "unique identifier of organization",
+          "readOnly": true,
+          "format": "uuid",
+          "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/org/definitions/username"
+            }
+          ]
+        },
+        "url": {
+          "description": "a link to the organization",
+          "example": "https://api.semaphoreci.com/api/v2/orgs/{org_username}",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "username": {
+          "description": "unique username of organization",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "name": {
+          "description": "name of organization",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "updated_at": {
+          "description": "when organization was updated",
+          "format": "date-time",
+          "type": [
+            "string"
+          ]
+        },
+        "created_at": {
+          "description": "when organization was created",
+          "format": "date-time",
+          "type": [
+            "string"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Info for existing organization.",
+          "href": "/orgs/{(%23%2Fdefinitions%2Forg%2Fdefinitions%2Fidentity)}",
+          "method": "GET",
+          "rel": "self",
+          "title": "Info"
+        },
+        {
+          "description": "List existing organizations.",
+          "href": "/orgs",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List"
+        }
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/org/definitions/id"
+        },
+        "url": {
+          "$ref": "#/definitions/org/definitions/url"
+        },
+        "username": {
+          "$ref": "#/definitions/org/definitions/username"
+        },
+        "name": {
+          "$ref": "#/definitions/org/definitions/name"
+        },
+        "updated_at": {
+          "$ref": "#/definitions/org/definitions/updated_at"
+        },
+        "created_at": {
+          "$ref": "#/definitions/org/definitions/created_at"
+        }
+      }
+    },
+    "team": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "title": "Team",
+      "description": "All aspects of team management",
+      "stability": "prototype",
+      "strictProperties": true,
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "id": {
+          "description": "unique identifier of team",
+          "readOnly": true,
+          "format": "uuid",
+          "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/team/definitions/id"
+            }
+          ]
+        },
+        "permission": {
+          "description": "unique name of team",
+          "readOnly": true,
+          "example": "admin",
+          "type": [
+            "string"
+          ],
+          "enum": [
+            "read",
+            "write",
+            "admin"
+          ]
+        },
+        "name": {
+          "description": "name of team",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "description": {
+          "description": "team description",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "url": {
+          "description": "a link to the team",
+          "example": "https://api.semaphoreci.com/api/v2/teams/{team_id}",
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "updated_at": {
+          "description": "when team was updated",
+          "format": "date-time",
+          "type": [
+            "string"
+          ]
+        },
+        "created_at": {
+          "description": "when team was created",
+          "format": "date-time",
+          "type": [
+            "string"
+          ]
+        }
+      },
+      "links": [
+        {
+          "description": "Create a new team.",
+          "href": "/orgs/{(%23%2Fdefinitions%2Forg%2Fdefinitions%2Fidentity)}/teams",
+          "method": "POST",
+          "rel": "create",
+          "schema": {
+            "properties": {
+              "name": {
+                "$ref": "#/definitions/team/definitions/name"
+              },
+              "description": {
+                "$ref": "#/definitions/team/definitions/description"
+              },
+              "permission": {
+                "$ref": "#/definitions/team/definitions/permission"
+              }
+            },
+            "required": [
+              "name",
+              "permission"
+            ],
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Create"
+        },
+        {
+          "description": "Delete an existing team.",
+          "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
+          "method": "DELETE",
+          "rel": "destroy",
+          "title": "Delete"
+        },
+        {
+          "description": "Info for existing team.",
+          "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
+          "method": "GET",
+          "rel": "self",
+          "title": "Info"
+        },
+        {
+          "description": "List existing teams for an org.",
+          "href": "/orgs/{(%23%2Fdefinitions%2Forg%2Fdefinitions%2Fidentity)}/teams",
+          "method": "GET",
+          "rel": "instances",
+          "title": "List"
+        },
+        {
+          "description": "Update an existing team.",
+          "href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}",
+          "method": "PATCH",
+          "rel": "update",
+          "schema": {
+            "properties": {
+              "name": {
+                "$ref": "#/definitions/team/definitions/name"
+              },
+              "description": {
+                "$ref": "#/definitions/team/definitions/description"
+              },
+              "permission": {
+                "$ref": "#/definitions/team/definitions/permission"
+              }
+            },
+            "type": [
+              "object"
+            ]
+          },
+          "title": "Update"
+        }
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/team/definitions/id"
+        },
+        "url": {
+          "$ref": "#/definitions/team/definitions/url"
+        },
+        "name": {
+          "$ref": "#/definitions/team/definitions/name"
+        },
+        "description": {
+          "$ref": "#/definitions/team/definitions/description"
+        },
+        "permission": {
+          "$ref": "#/definitions/team/definitions/permission"
+        },
+        "updated_at": {
+          "$ref": "#/definitions/team/definitions/updated_at"
+        },
+        "created_at": {
+          "$ref": "#/definitions/team/definitions/created_at"
+        }
+      }
+    }
+  },
+  "properties": {
+    "org": {
+      "$ref": "#/definitions/org"
+    },
+    "team": {
+      "$ref": "#/definitions/team"
+    }
+  },
+  "description": "Semaphore",
+  "id": "hello-prmd",
+  "links": [
+    {
+      "href": "https://api.semaphoreci.com/api/v2",
+      "rel": "self"
+    }
+  ],
+  "title": "Hello Prmd"
+}
+HEROICS_SCHEMA
+end

data/lib/semaphoreci_api/version.rb

@@ -0,0 +1,3 @@
+module SemaphoreciApi
+  VERSION = "0.1.1"
+end

data/semaphoreci_api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'semaphoreci_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "semaphoreci_api"
+  spec.version       = SemaphoreciApi::VERSION
+  spec.authors       = ["Darko Fabijan"]
+  spec.email         = ["darko@renderedtext.com"]
+
+  spec.summary       = "Ruby HTTP client for the Semaphore CI API."
+  spec.description   = "Ruby HTTP client for the Semaphore CI API."
+  spec.homepage      = "https://github.com/renderedtext/semaphoreci_api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yard"
+
+  spec.add_dependency "heroics", "~> 0.0.21"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: semaphoreci_api
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Darko Fabijan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: yard
+  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: heroics
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.21
+description: Ruby HTTP client for the Semaphore CI API.
+email:
+- darko@renderedtext.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/client-config.rb
+- lib/semaphoreci_api.rb
+- lib/semaphoreci_api/client.rb
+- lib/semaphoreci_api/version.rb
+- semaphoreci_api.gemspec
+homepage: https://github.com/renderedtext/semaphoreci_api
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby HTTP client for the Semaphore CI API.
+test_files: []