compact_index 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d64d44d1fea23ce0a76b7845acc0014b8ca8aec7
-  data.tar.gz: 51b9ae7960a546363e9d78327467f7a8b482ab68
+  metadata.gz: 1910b8bcbe07ae4b1503386a945c527e9dae0c82
+  data.tar.gz: eaccc11cf9d9d8e329b66278c1b6a4913225f882
 SHA512:
-  metadata.gz: 7aee9ae1d0b33076d8e6109cef53eee7c2e4e805007114f446b50736c9cfd4f3877fd2dbd27dcb1096294b771a90386ea2a6d20a3a39f35a18d0d267d2cd01ae
-  data.tar.gz: 434971c492a216938303c67a16cdb399a49aed8232065c6f93640830bf2e86e842debca4a3dffc51cf4f5431fb9b5ace7104c49db004ca67d0bff597e5ccf4c9
+  metadata.gz: f4c4d5386521b6e29028a09165f16af8cb5da09cd19fed220d003fdfc30e0b86ffeafd602e612830184d3a474090c0ac65d4b03a8f5f403a9d1a74a870e56af2
+  data.tar.gz: 222bf16b5c83f0927cd5770d7e63497ef410b3db62c280c10d5badf546e8e475f6437f5f87547ec161e6811dca8f3312cc434a56bd287650a01e13753855a1a3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.9.1 (August 19, 2015)
+
+Features:
+
+  - Add an option to CompactIndex.versions to calculate info_checksums on the fly
+
 ## 0.9.0 (August 17, 2015)
 
 Features:

data/README.md

@@ -2,7 +2,7 @@
 
 # CompactIndex
 
-Backend for bundler compact index. Used by rubygems.org and bundler-api
+This gem implements the response logic for the compact index format and to manage the versions file. The compact index format has three endpoints: `/names`, `/versions` and `/info/gem_name`. The versions file is a file which hold the versions in a cache-friendly way. You can see the body response formats on [this blog post](http://andre.arko.net/2014/03/28/the-new-rubygems-index-format/) from @indirect.
 
 ## Installation
 
@@ -16,11 +16,101 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install compact_index
+### `/names`
+
+To render the body for this call, all you have to do is generate a list of gems available in alfabetical order and use call `CompactIndex.names`.
+
+```ruby
+gem 'compact_index'
+CompactIndex.names(%W(a_test b_test c_test))
+```
+
+### `/versions`
+
+The body of this endpoint can be rendered calling the `CompactIndex.versions` method. It receives two paremeters: a `CompactIndex::VersionsFile` object and a set of extra gems that aren't in the file yet. The gems lists should be ordered consistently by the user.
+
+```ruby
+gem 'compact_index'
+# Create the object
+versions_file = CompactIndex::VersionsFile.new("/path/to/versions/file")
+
+# Get last updated date. This is used to discover what gems aren't  in the file yet
+from_date = @versions_file.updated_at
+
+# Query the extra gems using the from date. Format should be as follows
+extra_gems = [
+  {
+    name: "gem1",
+    versions: [
+      {
+        number: "0.9.8"
+        platform: "ruby"
+        checksum:  "abc123" #sha256 checksum available on rubygems.org
+      },
+      {
+        number: "0.9.9"
+        platform: "java"
+        checksum:  "abc123"
+      }
+    ]
+  },
+  {
+    name: "gem2",
+    versions: [
+      {
+        number: "0.9.8"
+        platform: "ruby"
+        checksum:  "abc123" #sha256 checksum available on rubygems.org
+      },
+      {
+        number: "0.9.9"
+        platform: "java"
+        checksum:  "abc123"
+      }
+    ]
+  }
+]
 
-## Usage
 
-TODO: Write usage instructions here
+# Render the body for the versions response
+CompactIndex.versions(@versions_file, extra_gems)
+```
+
+### `/info/gem_name`
+
+Much like `/versions`, the `/info/gem_name` expects a pre-defined structure to render the text on the screen. The lists also should be ordered by the user. This is the expected format:
+
+```ruby
+gem 'compact_index'
+
+# Expected versions format
+versions = [
+  {
+    number: '1.0.1',
+    checksum: "abc123",
+    dependencies: [
+      {
+        gem: 'foo',
+        version: '=1.0.1',
+        checksum: 'abc123'
+      }
+    ]
+  }
+]
+CompactIndex.info(versions)
+```
+
+### Updating the versions file
 
+The versions file creation and update are different. When created, all versions are at the side of the gem name, which appears only on one line. When updated, the file appends the new information on the end of the file, to avoid file changes.
+
+```ruby
+gem 'compact_index'
+
+versions_file = CompactIndex::VersionsFile.new(file_path)
+last_update = versions_file.updated_at
+gems = ... # Query your database, same format from `/versions` expected
+versions_file.update_with(gems)
+```

data/lib/compact_index/version.rb

@@ -1,3 +1,3 @@
 module CompactIndex
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/lib/compact_index/versions_file.rb

@@ -5,7 +5,11 @@ class CompactIndex::VersionsFile
     @path = file || "/versions.list"
   end
 
-  def contents(gems=nil)
+  def contents(gems=nil, args = {})
+    if args[:calculate_checksums]
+      gems = calculate_checksums(gems)
+    end
+
     out = File.read(@path)
     out << parse_gems(gems) if gems
     out
@@ -90,9 +94,16 @@ class CompactIndex::VersionsFile
 
     def number_and_platform(number, platform)
       if platform.nil? || platform == 'ruby'
-        number
+        number.dup
       else
         "#{number}-#{platform}"
       end
     end
+
+    def calculate_checksums(gems)
+      gems.each do |gem|
+        info_checksum = Digest::MD5.hexdigest(CompactIndex.info(gem[:versions]))
+        gem[:versions].first[:checksum] = info_checksum
+      end
+    end
 end

data/lib/compact_index.rb

@@ -6,8 +6,8 @@ module CompactIndex
     "---\n" << gem_names.join("\n") << "\n"
   end
 
-  def self.versions(versions_file, gems)
-    versions_file.contents(gems)
+  def self.versions(versions_file, gems, args)
+    versions_file.contents(gems, args)
   end
 
   def self.info(params)
@@ -46,7 +46,7 @@ module CompactIndex
 
     def self.number_and_platform(number, platform)
       if platform.nil? || platform == 'ruby'
-        number
+        number.dup
       else
         "#{number}-#{platform}"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compact_index
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - fotanus@gmail.com
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-18 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake