codecov_api 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b48651bc577638f6224494f15789aff728ecd0c
+  data.tar.gz: e779ee1c67a6b315e9e2ed5c24367aa440a65b14
+SHA512:
+  metadata.gz: 3932913c4d32cbd6e856a96b2e6ad9f251c2f2f6a9067a86ae63d46ef00bb6c8a71c82209350915eed08f265fbfbb9d958c1d22070f9ae948cef530d1f5ca495
+  data.tar.gz: 445d173463e3336be2db93a86d8b1d71a06aa9228c0d89e430dbacb3041821481cddb50e2163e51b0b436a84dc3876a7068f6a5606cffba1da53293427f3e05f

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Sebastian Nepote
+
+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,23 @@
+# codecov_api
+Unofficial toolset to consume CodeCov's API
+
+## Usage
+```bash
+export CODECOV_AUTH_TOKEN={CODECOV_AUTH_TOKEN}
+gem install codecov_api
+irb
+```
+```Ruby
+2.2.6 :001 > require 'codecov_api'
+ => true
+ 2.2.6 :002 > commits = CodecovApi::Api::Commits.new('snepote', 'codecov_api')
+  => #<CodecovApi::Api::Commits:0x007fee2043c298 @owner="snepote", @repo="codecov_api">
+ 2.2.6 :003 > commits.list
+```
+
+## CodeCov API
+* [Usage reference](https://docs.codecov.io/reference#usage)
+* See [Authorization](https://docs.codecov.io/reference#authorization) for instructions of how to create a token
+
+## Requirements
+* Ruby version: 2.2.6

data/lib/codecov_api/api/base.rb

@@ -0,0 +1,38 @@
+require 'rest-client'
+require 'json'
+
+module CodecovApi
+  module Api
+    class Base
+
+    protected
+
+      def get_request(path)
+        get_response(base_url + base_path + path)
+      end
+
+      def base_path
+        raise 'base_path method not defined'
+      end
+
+    private
+      def auth_token
+        raise 'CODECOV_AUTH_TOKEN ENV VAR not defined' if ENV['CODECOV_AUTH_TOKEN'].nil?
+        ENV['CODECOV_AUTH_TOKEN']
+      end
+
+      def base_url
+        'https://codecov.io/api/gh'
+      end
+
+      def get_response(url)
+        puts "GET #{url}"
+        RestClient::Request.new(
+          method: :get,
+          url: url,
+          headers: { :Authorization => 'token ' + auth_token }
+        ).execute
+      end
+    end
+  end
+end

data/lib/codecov_api/api/branches.rb

@@ -0,0 +1,30 @@
+require_relative 'base.rb'
+
+module CodecovApi
+  module Api
+    class Branches < Base
+      def initialize(owner, repo)
+        @owner = owner
+        @repo = repo
+      end
+
+      def list
+        get_request('/branches')
+      end
+
+      def get(branch)
+        get_request("/branch/#{branch}")
+      end
+
+      def delete(branch)
+        raise 'delete method not implemented'
+      end
+
+    protected
+
+      def base_path
+        "/#{@owner}/#{@repo}"
+      end
+    end
+  end
+end

data/lib/codecov_api/api/commits.rb

@@ -0,0 +1,31 @@
+require_relative 'base.rb'
+
+module CodecovApi
+  module Api
+    class Commits < Base
+      def initialize(owner, repo)
+        @owner = owner
+        @repo = repo
+      end
+
+      def list(from = nil, to = nil)
+        # todo: add from and to parameters
+        get_request('/commits')
+      end
+
+      def get(sha)
+        get_request("/commit/#{sha}")
+      end
+
+      def folder_totals(path, branch = 'master')
+        get_request("/tree/#{branch}/#{path}")
+      end
+
+    protected
+
+      def base_path
+        "/#{@owner}/#{@repo}"
+      end
+    end
+  end
+end

data/lib/codecov_api/objects/author.rb

@@ -0,0 +1,17 @@
+require_relative 'base.rb'
+
+module CodecovApi
+  module Objects
+    class Author < Base
+      protected
+
+      def valid_methods
+        [:service, :name, :email, :username, :service_id]
+      end
+
+      def root_element
+        @data['author']
+      end
+    end
+  end
+end

data/lib/codecov_api/objects/base.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module CodecovApi
+  module Objects
+    class Base
+      def initialize(json)
+        @data = JSON.parse(json.to_s)
+      end
+
+      protected
+
+      def valid_methods
+        raise 'valid_methods method not declared'
+      end
+
+      def root_element
+        raise 'root_element method not declared'
+      end
+
+      private
+
+      def method_missing(method, *args, &block)
+        super unless valid_methods.include? method
+        root_element[method.to_s]
+      end
+    end
+  end
+end

data/lib/codecov_api/objects/folder_totals.rb

@@ -0,0 +1,17 @@
+require_relative 'base.rb'
+
+module CodecovApi
+  module Objects
+    class FolderTotals < Base
+      protected
+
+      def valid_methods
+        [:files, :lines, :hits, :misses, :coverage]
+      end
+
+      def root_element
+        @data['commit']['folder_totals']
+      end
+    end
+  end
+end

data/lib/codecov_api/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module CodecovApi
+  VERSION = '0.0.0'
+end

data/lib/codecov_api.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require_relative 'codecov_api/api/commits'
+require_relative 'codecov_api/api/branches'
+require_relative 'codecov_api/objects/author'
+require_relative 'codecov_api/objects/folder_totals'

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: codecov_api
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Sebastian Nepote
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-08 00:00:00.000000000 Z
+dependencies: []
+description: Unofficial toolset to consume CodeCov's API
+email: snepote@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.md
+- README.md
+- lib/codecov_api.rb
+- lib/codecov_api/api/base.rb
+- lib/codecov_api/api/branches.rb
+- lib/codecov_api/api/commits.rb
+- lib/codecov_api/objects/author.rb
+- lib/codecov_api/objects/base.rb
+- lib/codecov_api/objects/folder_totals.rb
+- lib/codecov_api/version.rb
+homepage: https://github.com/snepote/codecov_api
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Codecov API
+test_files: []