berkshelf-api 1.2.2 → 1.3.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 1.3.0
+
+* Enhancements
+  * Added warning messages to startup when using github/file_store endpoints
+  * Bump Octokit dependency to ~> 3.0
+
+* Bug Fix
+  * Fixed issue with GH indexing where there were a high number of repositories in an organization
+
 # 1.2.2
 
 * Enhancements

data/README.md

@@ -95,11 +95,13 @@ You may configure the endpoints to index by editing the JSON configuration file
 }
 ```
 
-### Github Organization
+### GitHub Organization
 
-Github limits the rate of requests to their API if not authenticated. For this reason the access_token option
+> WARNING: Using the GitHub endpoint is *STRONGLY FROWNED UPON* and potentially *DANGEROUS*. Please consider setting up a proper release process for the cookbooks you wish to index instead where they are uploaded to the community site or a Chef Server and use the chef_server endpoint instead.
+
+GitHub limits the rate of requests to their API if not authenticated. For this reason the access_token option
 is required. The api_endpoint, web_endpoint and ssl_verify options are only needed when you want to point to
-a Github Enterprise server within your own organization
+a GitHub Enterprise server within your own organization
 
 ```json
 {

data/lib/berkshelf/api/cache_builder/worker/file_store.rb

@@ -4,6 +4,8 @@ module Berkshelf::API
       class FileStore < Worker::Base
         worker_type "file_store"
 
+        include Logging
+
         # @return [String]
         attr_reader :path
 
@@ -11,6 +13,13 @@ module Berkshelf::API
         #   the directory to search for local cookbooks
         def initialize(options = {})
           @path = Pathname(options[:path])
+          log.warn "You have configured a FileStore endpoint to index the contents of #{@path}."
+          log.warn "Using unfinalized artifacts, which this path may contain, to satisfiy your"
+          log.warn "dependencies is *STRONGLY FROWNED UPON* and potentially *DANGEROUS*."
+          log.warn ""
+          log.warn "Please consider setting up a release process for the cookbooks you wish to retrieve from this"
+          log.warn "filepathe where the cookbook is uploaded into a Hosted Chef organization, an internal"
+          log.warn "Chef Server, or the community site, and then replace this endpoint with a chef_server endpoint."
           super(options)
         end
 

data/lib/berkshelf/api/cache_builder/worker/github.rb

@@ -8,6 +8,8 @@ module Berkshelf::API
       class Github < Worker::Base
         worker_type "github"
 
+        include Logging
+
         # @return [String]
         attr_reader :organization
 
@@ -21,6 +23,15 @@ module Berkshelf::API
             api_endpoint: options[:api_endpoint], web_endpoint: options[:web_endpoint],
             connection_options: {ssl: {verify: options[:ssl_verify].nil? ? true : options[:ssl_verify]}})
           @organization = options[:organization]
+
+          log.warn "You have configured a GitHub endpoint to index the #{@organization} organization."
+          log.warn "Using unfinalized artifacts, such as cookbooks retrieved from Git, to satisfiy your"
+          log.warn "dependencies is *STRONGLY FROWNED UPON* and potentially *DANGEROUS*."
+          log.warn ""
+          log.warn "Please consider setting up a release process for the cookbooks you wish to retrieve from this"
+          log.warn "GitHub organization where the cookbook is uploaded into a Hosted Chef organization, an internal"
+          log.warn "Chef Server, or the community site, and then replace this endpoint with a chef_server endpoint."
+
           super(options)
         end
 

data/lib/berkshelf/api/version.rb

@@ -1,5 +1,5 @@
 module Berkshelf
   module API
-    VERSION = "1.2.2"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berkshelf-api
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-17 00:00:00.000000000 Z
+date: 2014-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ridley
@@ -195,7 +195,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -203,7 +203,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: semverse
   requirement: !ruby/object:Gem::Requirement
@@ -307,7 +307,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1179577401394136682
+      hash: 1518731648173016161
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23