gemfury 0.11.0 → 0.12.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d12fa40cc9a3b147996465039acb3ff1c44e121bc4c71679921f6db4c4729e9e
-  data.tar.gz: f0bf5539051922fd64bf240badf8b20e44d14cef36cd07de055b4710e764e05f
+  metadata.gz: fa1399aeab2f739da48ef55e4a7a6654ce9bb8527d722a9b7ce022ac082f2c2f
+  data.tar.gz: 176541eb909afc8610b8a4f94b3653dece97f898518a69fc137a7bd46533df25
 SHA512:
-  metadata.gz: 71a4bff9746b91c43de50d4f75796fd832e8b3cb2bc1b3b14be952be17c1a93a41b9725d4fc33b878d2a06620060748c8d29a607f1d74988b50ee613cef546d2
-  data.tar.gz: 3727b26c52de5c5f218f6fa81c5ed34a179e8a88805bd3e2846dc55f37e3fc931c047a723ba085c52dc68cb2b628fb88aa1932ea1ac87acc3584350b328f4c8f
+  metadata.gz: c69342a8284196e6e43b9a3dc3bead88cfe17b2ae098db213d5055314d703aefada6e5df8f4cd3d08a8c6a413bc27f211bd8f8be3dd802f4a8000f3c35121666
+  data.tar.gz: ed29f372dbec0526a614d2d8bb4ca8982ab47114a0c3d42857c4f06a480db690f7d9c898221b3be654b1e177f5d20f78382aa2069318a732b2a1ee08fb2ea71c

data/README.md

@@ -4,6 +4,8 @@ Gemfury CLI
 [![Gem Version](https://badge.fury.io/rb/gemfury.svg)](http://badge.fury.io/rb/gemfury)
 [![Build Status](https://secure.travis-ci.org/gemfury/gemfury.svg?branch=master)](https://travis-ci.org/gemfury/gemfury)
 [![Code Climate](https://codeclimate.com/github/gemfury/gemfury/badges/gpa.svg)](https://codeclimate.com/github/gemfury/gemfury)
+[![Documentation](https://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/gemfury)
+[![Documentation completeness](https://inch-ci.org/github/gemfury/gemfury.svg?branch=master)](http://inch-ci.org/github/gemfury/gemfury)
 
 This is the Gemfury CLI used to manage your Gemfury packages from the command line.  If you're
 familiar with the service and want to jump straight into command line action, please proceed to
@@ -30,6 +32,29 @@ any package to any host. It's simple, reliable, and hassle-free.
 * [Install private Composer packages](https://gemfury.com/help/php-composer-server)
 * [Private RubyGems on Heroku](https://gemfury.com/help/private-gems-on-heroku)
 
+
+## Using the Gemfury Client
+
+You can also use the client directly via Ruby; you will need a "Full access token" (API token) from `https://manage.fury.io/manage/YOUR-ACCOUNT-NAME/tokens/api`
+
+```ruby
+require 'gemfury'
+
+client = Gemfury::Client.new(user_api_key: "YOUR API TOKEN")
+
+all_artifacts = client.list
+puts "Available artifacts:"
+puts all_artifacts
+
+one_artifact = all_artifacts[0]
+puts "Versions of the #{one_artifact['language']} artifact #{one_artifact['name']}:"
+artifact_versions = client.versions(one_artifact["name"])
+puts artifact_versions.map { |v| v["version"] }
+```
+
+More information about the `Gemfury::Client` API is [hosted on rubydoc.info](https://rubydoc.info/gems/gemfury/Gemfury/Client).
+
+
 ## Contribution and Improvements
 
 Please [email us](mailto:support@gemfury.com) if we've missed some key functionality or you have problems installing the CLI client.  Better yet, fork the code, make the changes, and submit a pull request to speed things along.
@@ -59,4 +84,4 @@ Over time, dependencies for this gem will get stale and may interfere with your
 
 ## Questions
 
-Please email support@gemfury.com or file a Github Issue if you have any other questions or problems.
+Please email support@gemfury.com or file a Github Issue if you have any other questions or problems.

data/lib/gemfury.rb

@@ -1,5 +1,5 @@
 gem "multi_json",         "~> 1.10"
-gem "faraday",            ">= 0.9.0", "< 0.16.0.pre"
+gem "faraday",            ">= 0.9.0", "< 1.1.0.pre"
 gem "netrc",              ">= 0.10.0", "< 0.12.0.pre"
 
 require 'time'
@@ -23,6 +23,8 @@ require 'gemfury/client'
 
 module Gemfury
   extend Configuration
+  VALID_OPTIONS_KEYS = Configuration::CONFIGURATION_DEFAULTS.keys.freeze
+
   class << self
     # Alias for Gemfury::Client.new
     #
@@ -31,6 +33,27 @@ module Gemfury
       Gemfury::Client.new(options)
     end
 
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    # @return [Hash] the options and their values
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |options, k|
+        options[k] = send(k)
+        options
+      end
+    end
+
+    # Reset all configuration options to defaults
+    # @return [Configuration] The default configuration
+    def reset
+      CONFIGURATION_DEFAULTS.each { |k, v| send("#{k}=", v) }
+      self
+    end
+
     # Delegate to Gemfury::Client
     def method_missing(method, *args, &block)
       return super unless new.respond_to?(method)
@@ -40,14 +63,20 @@ module Gemfury
     def respond_to?(method, include_private = false)
       new.respond_to?(method, include_private) || super(method, include_private)
     end
+
   end
 end
 
+# Initialize configuration
+Gemfury.reset
+
+# Polyfill #dig for Ruby 2.2 and earlier
 class Hash
-  # Access nested hashes as a period-separated path
-  def path(path, separator = '.')
-    path.split(separator).inject(self) do |hash, part|
-      hash.is_a?(Hash) ? hash[part] : nil
+  unless self.instance_methods.include?(:dig)
+    def dig(*parts)
+      parts.inject(self) do |hash, part|
+        hash.is_a?(Hash) ? hash[part] : nil
+      end
     end
   end
 end

data/lib/gemfury/client.rb

@@ -1,31 +1,37 @@
 module Gemfury
   class Client
     include Gemfury::Client::Filters
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    include Gemfury::Configuration
 
     # Creates a new API
+    # @param options [Hash] values for attributes described in {Gemfury::Configuration}
     def initialize(options={})
       options = Gemfury.options.merge(options)
-      Configuration::VALID_OPTIONS_KEYS.each do |key|
+      Gemfury::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])
       end
     end
 
     # Get the information for the current account
+    # @return [Hash]
     def account_info
       ensure_ready!(:authorization)
       response = connection.get('users/me')
       checked_response_body(response)
     end
 
-    # Get the information for the current account
+    # Get the information for the all accounts that this account has some level of access to
+    # @return [Array<Hash>]
     def accounts
       ensure_ready!(:authorization)
       response = connection.get('accounts')
       checked_response_body(response)
     end
 
-    # Uploading a gem file
+    # Upload an artifact file
+    # @param file [String] the filename to upload
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
     def push_gem(file, options = {})
       ensure_ready!(:authorization)
       push_api = connection(:url => self.pushpoint)
@@ -33,14 +39,19 @@ module Gemfury
       checked_response_body(response)
     end
 
-    # List available gems
+    # List available artifacts
+    # @param options [Hash] Faraday client options
+    # @return [Array<Hash>]
     def list(options = {})
       ensure_ready!(:authorization)
       response = connection.get('gems', options)
       checked_response_body(response)
     end
 
-    # List versions for a gem
+    # List versions for an artifact
+    # @param name [String] the name of the artifact
+    # @param options [Hash] Faraday client options
+    # @return [Array<Hash>]
     def versions(name, options = {})
       ensure_ready!(:authorization)
       url = "gems/#{escape(name)}/versions"
@@ -48,7 +59,11 @@ module Gemfury
       checked_response_body(response)
     end
 
-    # Delete a gem version
+    # Delete an artifact version
+    # @param name [String] the name of the artifact
+    # @param version [String] the version of the artifact
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
     def yank_version(name, version, options = {})
       ensure_ready!(:authorization)
       url = "gems/#{escape(name)}/versions/#{escape(version)}"
@@ -62,6 +77,10 @@ module Gemfury
     end
 
     # Get authentication info via email/password
+    # @param email [String] the account email address
+    # @param password [String] the account password
+    # @param opts [Hash] Faraday client options
+    # @return [Hash]
     def login(email, password, opts = {})
       ensure_ready!
       opts = opts.merge(:email => email, :password => password)
@@ -69,6 +88,7 @@ module Gemfury
     end
 
     # Invalidate session token
+    # @return [Hash]
     def logout
       ensure_ready!(:authorization)
       response = connection.post('logout')
@@ -76,6 +96,8 @@ module Gemfury
     end
 
     # List collaborators for this account
+    # @param options [Hash] Faraday client options
+    # @return [Array<Hash>]
     def list_collaborators(options = {})
       ensure_ready!(:authorization)
       response = connection.get('collaborators', options)
@@ -83,6 +105,8 @@ module Gemfury
     end
 
     # Add a collaborator to the account
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
     def add_collaborator(login, options = {})
       ensure_ready!(:authorization)
       url = "collaborators/#{escape(login)}"
@@ -91,6 +115,9 @@ module Gemfury
     end
 
     # Remove a collaborator to the account
+    # @param login [String] the account login
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
     def remove_collaborator(login, options = {})
       ensure_ready!(:authorization)
       url = "collaborators/#{escape(login)}"
@@ -99,6 +126,8 @@ module Gemfury
     end
 
     # List Git repos for this account
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
     def git_repos(options = {})
       ensure_ready!(:authorization)
       response = connection.get(git_repo_path, options)
@@ -106,6 +135,9 @@ module Gemfury
     end
 
     # Update repository name and settings
+    # @param repo [String] the repo name
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
     def git_update(repo, options = {})
       ensure_ready!(:authorization)
       response = connection.patch(git_repo_path(repo), options)
@@ -113,6 +145,9 @@ module Gemfury
     end
 
     # Reset repository to initial state
+    # @param repo [String] the repo name
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
     def git_reset(repo, options = {})
       ensure_ready!(:authorization)
       response = connection.delete(git_repo_path(repo), options)
@@ -120,6 +155,9 @@ module Gemfury
     end
 
     # Rebuild Git repository package
+    # @param repo [String] the repo name
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
     def git_rebuild(repo, options = {})
       ensure_ready!(:authorization)
       url = "#{git_repo_path(repo)}/builds"
@@ -127,6 +165,30 @@ module Gemfury
       checked_response_body(api.post(url, options))
     end
 
+    # List Git repo's build configuration
+    # @param repo [String] the repo name
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
+    def git_config(repo, options = {})
+      ensure_ready!(:authorization)
+      path = "#{git_repo_path(repo)}/config-vars"
+      response = connection.get(path, options)
+      checked_response_body(response)
+    end
+
+    # Update Git repo's build configuration
+    # @param repo [String] the repo name
+    # @param updates [Hash] Updates to configuration
+    # @param options [Hash] Faraday client options
+    # @return [Hash]
+    def git_config_update(repo, updates, options = {})
+      ensure_ready!(:authorization)
+      path = "#{git_repo_path(repo)}/config-vars"
+      opts = options.merge(:config_vars => updates)
+      response = connection.patch(path, opts)
+      checked_response_body(response)
+    end
+
   private
     def escape(str)
       CGI.escape(str)

data/lib/gemfury/command.rb

@@ -1,5 +1,6 @@
+gem "progressbar", ">= 1.10.1", "< 2.0.0.pre"
 gem "highline", ">= 1.6.0", "< 2.1.0.pre"
-gem "thor",     ">= 0.14.0", "< 1.0.0.pre"
+gem "thor",     ">= 0.14.0", "< 1.1.0.pre"
 
 require 'thor'
 require 'yaml'

data/lib/gemfury/command/app.rb

@@ -35,7 +35,7 @@ class Gemfury::Command::App < Thor
       va = [ %w{ name kind version privacy } ]
       gems.each do |g|
         va << [ g['name'], g['language'],
-                g.path('latest_version.version') || 'beta',
+                g.dig('latest_version', 'version') || 'beta',
                 g['private'] ? 'private' : 'public ' ]
       end
 
@@ -224,6 +224,40 @@ class Gemfury::Command::App < Thor
     end
   end
 
+  ### GIT REPOSITORY BUILD CONFIG ###
+  map 'git:config'       => 'git_config'
+  map 'git:config:set'   => 'git_config_set'
+  map 'git:config:unset' => 'git_config_unset'
+
+  desc "git:config", "List Git repository's build environment"
+  def git_config(repo)
+    with_checks_and_rescues do
+      vars = client.git_config(repo)['config_vars']
+      shell.say "*** #{repo} build config ***\n"
+      shell.print_table(vars.map { |kv|
+        ["#{kv[0]}:", kv[1]]
+      })
+    end
+  end
+
+  desc "git:config:set", "Update Git repository's build environment"
+  def git_config_set(repo, *vars)
+    with_checks_and_rescues do
+      updates = Hash[vars.map { |v| v.split("=", 2) }]
+      client.git_config_update(repo, updates)
+      shell.say "Updated #{repo} build config"
+    end
+  end
+
+  desc "git:config:unset", "Remove variables from Git repository's build environment"
+  def git_config_unset(repo, *vars)
+    with_checks_and_rescues do
+      updates = Hash[vars.map { |v| [v, nil] }]
+      client.git_config_update(repo, updates)
+      shell.say "Updated #{repo} build config"
+    end
+  end
+
 private
   def client
     opts = {}

data/lib/gemfury/configuration.rb

@@ -1,72 +1,48 @@
 module Gemfury
-  # Defines constants and methods related to configuration
   module Configuration
-    # An array of valid keys in the options hash when configuring
-    VALID_OPTIONS_KEYS = [
-      :user_api_key,
-      :adapter,
-      :endpoint,
-      :gitpoint,
-      :pushpoint,
-      :user_agent,
-      :api_version,
-      :account].freeze
 
-    # The adapter that will be used to connect if none is set
-    DEFAULT_ADAPTER = :net_http
-
-    # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT  = 'https://api.fury.io/'.freeze
+    CONFIGURATION_DEFAULTS = {
+      :user_api_key => nil,
+      :adapter => :net_http,
+      :endpoint => 'https://api.fury.io/',
+      :gitpoint => 'https://git.fury.io/',
+      :pushpoint => 'https://push.fury.io/',
+      :user_agent => "Gemfury RubyGem #{Gemfury::VERSION} (Ruby #{RUBY_VERSION})",
+      :api_version => 1,
+      :account => nil
+    }.freeze
+
+    # user API key, also known as "full access token"
+    # @return [String]
+    attr_accessor :user_api_key
+
+    # The adapter that will be used to connect
+    # @return [Symbol]
+    attr_accessor :adapter
+
+    # The endpoint that will be used to connect
+    # @return [String]
+    attr_accessor :endpoint
 
     # The HTTP endpoint for git repo (used for .netrc credentials)
-    DEFAULT_GITPOINT  = 'https://git.fury.io/'.freeze
-
-    # The endpoint for the Push API if not set
-    DEFAULT_PUSHPOINT = 'https://push.fury.io/'.freeze
-
-    # The value sent in the 'User-Agent' header if none is set
-    DEFAULT_USER_AGENT = "Gemfury RubyGem #{Gemfury::VERSION}".freeze
-
-    # Default API version
-    DEFAULT_API_VERSION = 1
-
-    # Default user API key
-    DEFAULT_API_KEY = nil
-
-    # Use the current account (no impersonation)
-    DEFAULT_ACCOUNT = nil
-
-    # @private
-    attr_accessor *VALID_OPTIONS_KEYS
+    # @return [String]
+    attr_accessor :gitpoint
 
-    # When this module is extended, set all configuration options to their default values
-    def self.extended(base)
-      base.reset
-    end
+    # The endpoint for the Push API
+    # @return [String]
+    attr_accessor :pushpoint
 
-    # Convenience method to allow configuration options to be set in a block
-    def configure
-      yield self
-    end
+    # The value sent in the 'User-Agent' header
+    # @return [String]
+    attr_accessor :user_agent
 
-    # Create a hash of options and their values
-    def options
-      options = {}
-      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
-      options
-    end
+    # Gemfury remote API version
+    # @return [Integer]
+    attr_accessor :api_version
 
-    # Reset all configuration options to defaults
-    def reset
-      self.user_api_key       = DEFAULT_API_KEY
-      self.adapter            = DEFAULT_ADAPTER
-      self.endpoint           = DEFAULT_ENDPOINT
-      self.gitpoint           = DEFAULT_GITPOINT
-      self.pushpoint          = DEFAULT_PUSHPOINT
-      self.user_agent         = DEFAULT_USER_AGENT
-      self.api_version        = DEFAULT_API_VERSION
-      self.account            = DEFAULT_ACCOUNT
-      self
-    end
+    # The account to impersonate, if you have permissions for multiple accounts
+    # (If nil, no impersonation)
+    # @return [String]
+    attr_accessor :account
   end
 end

data/lib/gemfury/version.rb

@@ -1,3 +1,3 @@
 module Gemfury
-  VERSION = '0.11.0'
+  VERSION = '0.12.0.rc1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gemfury
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0.rc1
 platform: ruby
 authors:
 - Michael Rykov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -33,7 +33,7 @@ dependencies:
         version: 0.14.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre
+        version: 1.1.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 0.14.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.0.0.pre
+        version: 1.1.0.pre
 - !ruby/object:Gem::Dependency
   name: netrc
   requirement: !ruby/object:Gem::Requirement
@@ -73,7 +73,7 @@ dependencies:
         version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.16.0.pre
+        version: 1.1.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -83,7 +83,7 @@ dependencies:
         version: 0.9.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: 0.16.0.pre
+        version: 1.1.0.pre
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -118,6 +121,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.10.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre
 description: 'Hosted repo for your public and private packages at https://gemfury.com
 
 '
@@ -179,9 +185,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.8