cloudphoto 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9ef019fa79aa7bd1582bbde0be2e427fbf50211eb18862bf56a49665ce56be9
+  data.tar.gz: 8e013197356521a9674919a1ea1fe585ae43a43af41736e74c100d87057a04fd
+SHA512:
+  metadata.gz: 1b16cf4b7e25be346cf09176bcabaf045133fcbc86f1eede2eae7c0ab520d9fd751238f5040e11ba2753527a9ed15acfb1a0326fe1bcd3e03bb8a1a942942927
+  data.tar.gz: bcaac00b277b21376b2908d1ba6e0fabda9adeb06962d8c9d88f425597697eceab3fe235f18026cd6b7a93d4a6e36678cab66fbf4cc17e2aa23328608a8a524f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dmitry.barskov@flatstack.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cloudphoto.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    cloudphoto (0.1.0)
+      aws-sdk-s3 (~> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-eventstream (1.1.0)
+    aws-partitions (1.399.0)
+    aws-sdk-core (3.109.3)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.239.0)
+      aws-sigv4 (~> 1.1)
+      jmespath (~> 1.0)
+    aws-sdk-kms (1.39.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.85.0)
+      aws-sdk-core (~> 3, >= 3.109.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
+    aws-sigv4 (1.2.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    diff-lcs (1.4.4)
+    jmespath (1.4.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cloudphoto!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dmitry Barskov
+
+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,81 @@
+# Cloudphoto
+
+Command line utility for managing photos in AWS S3.
+
+## Installation
+
+Install gem from command line:
+
+```bash
+gem install cloudphoto
+```
+
+## Usage
+
+#### Configure environment vairables:
+
+```bash
+export AWS_REGION=us-east-1
+```
+see list of available regions [here](https://docs.aws.amazon.com/general/latest/gr/rande.html).
+
+Configure AWS credentials in `~/.aws/credentials`
+(see this [blog post](https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/)).
+
+Provide bucket name
+```bash
+export CLOUDPHOTO_BUCKET=cloudphoto1
+```
+
+or pass it to executable
+```bash
+CLOUDPHOTO_BUCKET=photos cloudphoto list
+```
+
+### Upload pictures to cloud storage
+
+Uploads all the photos (in jpeg/jpg format) from `path` directory (not recursively)
+and adds them to `album` album.
+
+```bash
+cloudphoto upload -p path -a album
+```
+
+### Download pictures to have it locally
+
+Downloads all the pictures related to `album` album to `path` directory.
+
+```bash
+cloudphoto download -p path -a album
+```
+
+### List albums in cloud storage
+
+```bash
+cloudphoto list
+```
+
+### List specific album photos in cloud storage
+
+```bash
+cloudphoto list -a album
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryBarskov/cloudphoto. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/DmitryBarskov/cloudphoto/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Cloudphoto project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/DmitryBarskov/cloudphoto/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cloudphoto"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cloudphoto.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/cloudphoto/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloudphoto"
+  spec.version       = Cloudphoto::VERSION
+  spec.authors       = ["Dmitry Barskov"]
+  spec.email         = ["dmitry.barskov64@gmail.com"]
+
+  spec.summary       = "Simple photo gallery for AWS S3"
+  spec.description   = "Upload photos, create albums on AWS S3 using CLI"
+  spec.homepage      = "https://github.com/DmitryBarskov/cloudphoto"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk-s3", "~> 1"
+end

data/exe/cloudphoto

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "cloudphoto"
+
+Cloudphoto.cli(*ARGV)

data/lib/cloudphoto.rb

@@ -0,0 +1,6 @@
+require "cloudphoto/version"
+require "cloudphoto/cli"
+
+module Cloudphoto
+  ALBUMS_PREFIX = ".albums".freeze
+end

data/lib/cloudphoto/aws/aws.rb

@@ -0,0 +1,45 @@
+require "aws-sdk-s3"
+
+module Cloudphoto
+  module Aws
+    def s3_client
+      @s3_client ||= ::Aws::S3::Client.new(region: require_env("AWS_REGION"))
+    end
+
+    def s3_resource
+      @s3_resource ||= ::Aws::S3::Resource.new(client: s3_client)
+    end
+
+    def bucket
+      @bucket ||= require_env("CLOUDPHOTO_BUCKET")
+    end
+
+    def list_objects
+      s3_client.list_objects_v2(bucket: bucket).contents.map(&:key)
+    end
+
+    def upload_object(file_path, to:)
+      s3_client.put_object(bucket: bucket, key: to)
+      object = s3_resource.bucket(bucket).object(to)
+      File.open(file_path, 'rb') do |file|
+        object.put(body: file)
+      end
+    rescue StandardError => e
+      puts e
+      false
+    end
+
+    def download_object(key:, to:)
+      s3_client.get_object({ bucket: bucket, key: key }, target: to)
+    end
+
+    def require_env(key)
+      return ENV[key] if ENV[key]
+
+      raise ArgumentError.new("Missing environment variable #{key}")
+    end
+
+    module_function :require_env, :s3_client, :bucket, :list_objects,
+      :upload_object, :download_object, :s3_resource
+  end
+end

data/lib/cloudphoto/cli.rb

@@ -0,0 +1,33 @@
+require "optparse"
+
+require "cloudphoto/help"
+require "cloudphoto/list"
+require "cloudphoto/upload"
+require "cloudphoto/download"
+
+module Cloudphoto
+  def cli(command = "help", *args)
+    return Cloudphoto.help unless Cloudphoto.respond_to?(command)
+
+    options = {}
+    OptionParser.new do |opts|
+      opts.on("-a", "--album ALBUM", "Album name") do |album|
+        options[:album] = album
+      end
+
+      opts.on("-p", "--path path", "Path to upload/download photos to/from") do |path|
+        options[:path] = path
+      end
+
+      opts.on("-h", "--help", "Print this help") do
+        return Cloudphoto.help(command)
+      end
+    end.parse!(args)
+
+    Cloudphoto.send(command, **options) if options
+  rescue ArgumentError => e
+    puts e
+    Cloudphoto.help(command)
+  end
+  module_function :cli
+end

data/lib/cloudphoto/download.rb

@@ -0,0 +1,13 @@
+require "cloudphoto/aws/aws"
+
+module Cloudphoto
+  def download(album:, path:)
+    photo_keys = Cloudphoto::List.list_keys("#{ALBUMS_PREFIX}/#{album}/")
+
+    photos = photo_keys.map do |key|
+      Cloudphoto::Aws.download_object(key: key, to: "#{path}/#{File.basename(key)}")
+    end
+
+  end
+  module_function :download
+end

data/lib/cloudphoto/help.rb

@@ -0,0 +1,38 @@
+module Cloudphoto
+  def help(command = nil)
+    puts <<~HELP
+    Usage: cloudphoto <command> [options]
+    Available commands:
+      download - download album from cloud storage
+      upload - upload photos to cloud storage
+      list - show ablum names in cloud storage
+    HELP
+
+    puts Help.send("help_#{command}") if command && respond_to?(command)
+  end
+  module_function :help
+
+  module Help
+    def help_upload
+      <<~HELP
+        cloudphoto upload -p path -a album
+        Upload all photos in **path** directory to **album** album
+      HELP
+    end
+
+    def help_download
+      <<~HELP
+        cloudphoto download -p path -a album
+        Download all photos from **album** album to **path** directory
+      HELP
+    end
+
+    def help_list
+      <<~HELP
+        cloudphoto list -a album
+        List available photos in **album** album
+      HELP
+    end
+    module_function :help_list, :help_download, :help_upload
+  end
+end

data/lib/cloudphoto/list.rb

@@ -0,0 +1,38 @@
+require "cloudphoto/aws/aws"
+
+module Cloudphoto
+  def list(album: nil)
+    list = if album.nil?
+      List.list_albums
+    else
+      List.list_photos(album)
+    end
+
+    puts "total #{list.size}"
+    puts list
+  end
+  module_function :list
+
+  module List
+    def list_albums
+      albums = Cloudphoto::Aws.list_objects.select do |path|
+        /\A\.albums\/.+?\/\z/.match?(path)
+      end
+      albums.map! { |path| path.delete_prefix("#{ALBUMS_PREFIX}/").delete_suffix("/") }
+    end
+
+    def list_photos(album)
+      album_path = "#{ALBUMS_PREFIX}/#{album}/"
+      photos = list_keys(album_path)
+      photos.map! { |path| path.delete_prefix(album_path) }
+    end
+
+    def list_keys(prefix)
+      Cloudphoto::Aws.list_objects.select do |path|
+        path.start_with?(prefix)
+      end.reject { |path| path == prefix }
+    end
+
+    module_function :list_albums, :list_photos, :list_keys
+  end
+end

data/lib/cloudphoto/upload.rb

@@ -0,0 +1,19 @@
+require "cloudphoto/aws/aws"
+
+module Cloudphoto
+  def upload(path:, album:)
+    photos = Dir["#{path}/*.jpeg"] + Dir["#{path}/*.jpg"]
+    result = photos.map do |photo|
+      uploaded = Cloudphoto::Aws.upload_object(
+        photo,
+        to: "#{ALBUMS_PREFIX}/#{album}/#{File.basename(photo)}"
+      )
+      [photo, uploaded]
+    end
+
+    result.each do |path, success|
+      puts "Upload #{path} #{success ? 'done' : 'fail'}"
+    end
+  end
+  module_function :upload
+end

data/lib/cloudphoto/version.rb

@@ -0,0 +1,3 @@
+module Cloudphoto
+  VERSION = "0.1.2"
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: cloudphoto
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Dmitry Barskov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Upload photos, create albums on AWS S3 using CLI
+email:
+- dmitry.barskov64@gmail.com
+executables:
+- cloudphoto
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cloudphoto.gemspec
+- exe/cloudphoto
+- lib/cloudphoto.rb
+- lib/cloudphoto/aws/aws.rb
+- lib/cloudphoto/cli.rb
+- lib/cloudphoto/download.rb
+- lib/cloudphoto/help.rb
+- lib/cloudphoto/list.rb
+- lib/cloudphoto/upload.rb
+- lib/cloudphoto/version.rb
+homepage: https://github.com/DmitryBarskov/cloudphoto
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/DmitryBarskov/cloudphoto
+  source_code_uri: https://github.com/DmitryBarskov/cloudphoto
+  changelog_uri: https://github.com/DmitryBarskov/cloudphoto/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple photo gallery for AWS S3
+test_files: []