lsst-git-lfs-s3 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68caf4d6acf139d3cc4f120bc7715b7fc129a444
-  data.tar.gz: 78d03cd5f3d5428049b1f9f6918e78109bd97208
+  metadata.gz: c281e6b4092827cee2ff392f15e5edfcd87e5a54
+  data.tar.gz: b17910a8176a51e1be82853e7cf68dde2f145abc
 SHA512:
-  metadata.gz: 1d1d01d2052bda7b8a93b82f0f9c62e387225f3c46dbfb0eef75d6b581814af58c805364c67c7a1a74cbf91b476cca929a860c4b442214a614183b9793b8e4a6
-  data.tar.gz: ce0faca488560ff2f38fdaa6589c56d6c8c33d578af4d3be7a1f8a15c474523118392161ec2582b61ff81f32889845edeb9f61e34a1aa0ea96aafb7d82e506f7
+  metadata.gz: ea4536a92be8d1a73173de01f92ac1efc0d95c08b6f035a8544902fca1895d76b1342bcd575f82cd8f49df0b5a079e852810d1e1aab0ca93c0f8c01dae268469
+  data.tar.gz: a20908659964e73b8452aba86ff4afe0a43181c3f9547dc6e587594cc40d6a4ffb967c27c87bbd1a0f7b7e0023a3315ab3aabc8642976fe6d94fab25d9dc8716

data/README.md

@@ -1,4 +1,4 @@
-# Git LFS S3
+# LSST's Git LFS S3
 
 A [Git LFS](https://git-lfs.github.com/) server that stores your large Git files on S3.
 
@@ -9,7 +9,7 @@ It works by generating a presigned URL that the Git LFS client can use to upload
 Git LFS S3 is available on RubyGems.
 
 ``` bash
-gem install git-lfs-s3
+gem install lsst-git-lfs-s3
 ```
 
 Or add it to your Gemfile if you wish to bundle it as a part of another application.
@@ -29,9 +29,6 @@ All configuration is done via environment variables. All of these configuration
 * `AWS_SECRET_ACCESS_KEY` - your AWS secret key.
 * `S3_BUCKET` - the bucket you wish to use for LFS storage. While not required, I recommend using a dedicated bucket for this.
 * `LFS_SERVER_URL` - the URL where this server can be reached; needed to fetch download URLs.
-* `LFS_PUBLIC_SERVER` - (Optional) Support anonymous users for safe operations such as git-clone and git-pull.
-* `LFS_CEPH_S3` - (Optional) support [Ceph S3](http://ceph.com/) (Hammer version, through radosgw).
-* `LFS_CEPH_ENDPOINT` - (Optional) the Ceph S3 endpoint URL. Required when using `LFS_CEPH_S3`.
 
 You can (and should) also set authentication information. When you push for the first time from git, you will be prompted to enter a username and password when authentication is enabled. You can configure these with environment variables as well.
 
@@ -68,7 +65,6 @@ If you are new to Git LFS, make sure you read the [Getting Started](https://git-
 ``` git
 [lfs]
     url = "http://yourserver.com"
-    batch = false
 ```
 
 Once that is done, you can tell Git LFS to track files with `git lfs track "*.psd"`, for example.
@@ -87,19 +83,6 @@ However, because this is a Sinatra application, it can also be mounted within ot
 mount GitLfsS3::Application => '/lfs'
 ```
 
-
-
-Allow anonymous clones and pulls of the git-lfs git repository.
-
-## Ceph S3 Server
-
-Through the `LFS_CEPH_S3` and `LFS_CEPH_ENDPOINT` environment variables use a Ceph S3 storage service (Hammer version, through radosgw) instead of AWS S3.
-
-## More Complex Server Example
-
-* https://github.com/lsst-sqre/git-lfs-s3-server
-
 ## TODO
 
-* Cloudfront support.
-* Batch API support.
+* Cloudfront support

data/git-lfs-s3.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |gem|
   gem.version       = GitLfsS3::VERSION
   gem.authors       = ["Ryan LeFevre", "J. Matt Peterson"]
   gem.email         = ["meltingice8917@gmail.com", "jmatt@lsst.org"]
-  gem.description   = %q{A Git LFS server that uses S3 for the storage backend.}
-  gem.summary       = %q{A Git LFS server that uses S3 for the storage backend by providing presigned S3 URLs.}
-  gem.homepage      = "https://github.com/meltingice/git-lfs-s3"
+  gem.description   = %q{LSST's Git LFS server that uses S3 for the storage backend.}
+  gem.summary       = %q{LSST's Git LFS server that uses S3 for the storage backend by providing presigned S3 URLs.}
+  gem.homepage      = "https://github.com/lsst-sqre/git-lfs-s3"
   gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)

data/lib/git-lfs-s3/application.rb

@@ -49,142 +49,142 @@ module GitLfsS3
       "Git LFS S3 is online."
     end
 
-    def valid_object?(object)
+    def valid_obj?(obj)
+      # Validate that size >= 0 and oid is a SHA256 hash.
       begin
-        valid = object[:size] >= 0
-      rescue
-        valid = false
-      end
-      begin        
-        if valid
-          oid = object[:oid].hex
-          valid = oid.size == 32 && object[:oid].size == 64
+        if obj[:size] >= 0
+          oid = obj[:oid]
+          valid = (oid.hex.size <= 32) and (oid.size == 64) and (oid =~ /^[0-9a-f]+$/)
         end
-      rescue
-        valid = false
       end
-      valid
     end
 
-    def object_download(authenticated, object, object_json)
-      oid = object_json[:oid]
-      size = object_json[:size]
+    def expire_at()
+      DateTime.now.next_day.to_time.utc.iso8601
+    end
+
+    def obj_download(authenticated, obj, obj_json)
+      # Format a single download object.
+      oid = obj_json[:oid]
+      size = obj_json[:size]
       {
-        'oid' => oid,
-        'size' => size,
+        'oid'           => oid,
+        'size'          => size,
         'authenticated' => authenticated,
-        'actions' => {
-          'download' => {
-            'href' => object.presigned_url(:get, :expires_in => 86400)
-          }
+        'actions'       => {
+          'download'  => {
+            'href'  => obj.presigned_url(:get,
+                                         :expires_in => 86400),
+          },
         },
-        'expires_at' => DateTime.now.next_day.to_time.utc.iso8601
+        'expires_at'    => expire_at,
       }
     end
 
-    def object_upload(authenticated, object, object_json)
+    def obj_upload(authenticated, obj, obj_json)
       # Format a single upload object.
-      oid = object_json[:oid]
-      size = object_json[:size]
+      oid = obj_json[:oid]
+      size = obj_json[:size]
       {
-        'oid' => oid,
-        'size' => size,
+        'oid'           => oid,
+        'size'          => size,
         'authenticated' => authenticated,
-        'actions' => {
-          'upload' => {
-            'href' => object.presigned_url(:put, acl: 'public-read', :expires_in => 86400)
-          }
+        'actions'       => {
+          'upload'    => {
+            'href'  => obj.presigned_url(:put,
+                                         acl: 'public-read',
+                                         :expires_in => 86400),
+          },
+          'expires_at'  => expire_at,
         },
-        'expires_at' => DateTime.now.next_day.to_time.utc.iso8601
       }
     end
 
-    def object_error(error, message, object, object_json)
+    def obj_error(error, message, obj_json)
+      # Format a single error object.
       {
-        'oid' => object_json[:oid],
-        'size' => object_json[:size],
-        'error' => {
-          'code' => error,
-          'message' => message
-        }
+        'oid'         => obj_json[:oid],
+        'size'        => obj_json[:size],
+        'error'       => {
+          'code'    => error,
+          'message' => message,
+        },
       }
     end
 
     def download(authenticated, params)
-      objects = Array.new
-      params[:objects].each do |object_json|
-        object_json = indifferent_params object_json
-        object = object_data object_json[:oid]
-        if valid_object? object_json
-          if object.exists?
-            objects.push object_download(authenticated, object, object_json)
+      # Handle git-lfs batch downloads.
+      objects = []
+      params[:objects].each do |obj_json|
+        obj_json = indifferent_params(obj_json)
+        obj = object_data(obj_json[:oid])
+        if valid_obj?(obj_json)
+          if obj.exists?
+            objects.push(obj_download(authenticated, obj, obj_json))
           else
-            objects.push object_error(404, 'Object does not exist', object, object_json)
+            objects.push(obj_error(404, 'Object does not exist', obj_json))
           end
         else
-          objects.push object_error(422, 'Validation error', object, object_json)
+          objects.push(obj_error(422, 'Validation error', obj_json))
         end
       end
       objects
     end
 
     def upload(authenticated, params)
-      objects = Array.new
-      params[:objects].each do |object_json|
-        object_json = indifferent_params object_json
-        object = object_data object_json[:oid]
-        if valid_object? object_json
-          if object.exists?
-            objects.push object_download(authenticated, object, object_json)
+      # Handle git-lfs batch uploads.
+      objects = []
+      params[:objects].each do |obj_json|
+        obj_json = indifferent_params(obj_json)
+        obj = object_data(obj_json[:oid])
+        if valid_obj?(obj_json)
+          if obj.exists?
+            objects.push(obj_download(authenticated, obj, obj_json))
           else
-            objects.push object_upload(authenticated, object, object_json)
+            objects.push(obj_upload(authenticated, obj, obj_json))
           end
         else
-          objects.push object_error(422, 'Validation error', object, object_json)
+          objects.push(obj_error(422, 'Validation error', obj_json))
         end
       end
       objects
-    end
+      end
 
     def lfs_resp(objects)
-      status 200
+      # Successful git-lfs batch response.
+      status(200)
       resp = {
         'transfer' => 'basic',
         'objects' => objects
       }
-      logger.debug resp
       body MultiJson.dump(resp)
     end
     
     def error_resp(status_code, message)
-      status status_code
+      # Error git-lfs batch response.
+      status(status_code)
       resp = {
         'message' => message,
         'request_id' => SecureRandom::uuid
       }
-      logger.debug resp
       body MultiJson.dump(resp)
     end
     
     post '/objects/batch', provides: 'application/vnd.git-lfs+json' do
-      # Git LFS Batch API
+      # git-lfs batch API
       authenticated = authorized?
       params = indifferent_params(JSON.parse(request.body.read))
-      
+      logger.debug params
       if params[:operation] == 'download'
-        objects = download(authenticated, params)
+        lfs_resp(download(authenticated, params))
       elsif params[:operation] == 'upload'
         if authenticated
-          objects = upload(authenticated, params)
+          lfs_resp(upload(authenticated, params))
         else
-          objects = nil
+          error_resp(401, 'Credentials needed')
         end
-      end
-      
-      if objects
-        lfs_resp(objects)
       else
-        error_resp(401, 'Credentials needed')
+        error_resp(422, 'Validation error')
       end
     end
 
@@ -235,16 +235,6 @@ module GitLfsS3
       body MultiJson.dump(service.response)
     end
 
-    post "/objects/batch", provides: 'application/vnd.git-lfs+json' do
-      logger.debug headers.inspect
-      service = UploadBatchService.service_for(request.body)
-      logger.debug service.response
-      
-      status service.status
-      body MultiJson.dump(service.response)
-    end
-
-
     post '/verify', provides: 'application/vnd.git-lfs+json' do
       data = MultiJson.load(request.body.tap { |b| b.rewind }.read)
       object = object_data(data['oid'])

data/lib/git-lfs-s3/version.rb

@@ -1,3 +1,3 @@
 module GitLfsS3
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lsst-git-lfs-s3
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ryan LeFevre
@@ -67,7 +67,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-description: A Git LFS server that uses S3 for the storage backend.
+description: LSST's Git LFS server that uses S3 for the storage backend.
 email:
 - meltingice8917@gmail.com
 - jmatt@lsst.org
@@ -91,7 +91,7 @@ files:
 - lib/git-lfs-s3/services/upload/object_exists.rb
 - lib/git-lfs-s3/services/upload/upload_required.rb
 - lib/git-lfs-s3/version.rb
-homepage: https://github.com/meltingice/git-lfs-s3
+homepage: https://github.com/lsst-sqre/git-lfs-s3
 licenses:
 - MIT
 metadata: {}
@@ -114,6 +114,6 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: A Git LFS server that uses S3 for the storage backend by providing presigned
+summary: LSST's Git LFS server that uses S3 for the storage backend by providing presigned
   S3 URLs.
 test_files: []