cloudapp-service 1.0.0.beta.1

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Change Log
+
+Below is a complete listing of changes for each revision of `cloudapp`.
+
+## Unreleased
+
+ - Use new [hypermedia CloudApp API][api].
+ - Extract CLI into [cloudapp-cli gem][cli].
+ - Much refactoring
+
+[api]: http://developer.getcloudapp.com/api-v2/
+[cli]: https://github.com/cloudapp/cloudapp-cli
+
+## 1.1.0
+
+ - Add `download` command
+ - General housecleaning in `bin/cloudapp`
+ - Fix typo ([#22][] by [Mark Mulder][bittersweet])
+ - Extract Config class
+
+[#22]: https://github.com/cloudapp/cloudapp/pull/22
+[bittersweet]: https://github.com/bittersweet
+
+## 1.0.2
+
+ - Bump leadlight and relax highline dependencies.
+
+## 1.0.1
+
+ - Tightened leadlight and highline dependencies.
+
+## 1.0.0
+
+ - Stable release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    cloudapp-service (1.0.0.beta.1)
+      leadlight (~> 0.0.7)
+      typhoeus (~> 0.3.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    fail-fast (1.0.0)
+    faraday (0.8.1)
+      multipart-post (~> 1.1)
+    fattr (2.2.1)
+    hookr (1.1.1)
+      fail-fast (= 1.0.0)
+    leadlight (0.0.7)
+      addressable (~> 2.2.0)
+      faraday (= 0.8.1)
+      fattr
+      hookr
+      link_header
+      mime-types
+      multi_json (~> 1.0.4)
+    link_header (0.0.5)
+    mime-types (1.19)
+    multi_json (1.0.4)
+    multipart-post (1.1.5)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    typhoeus (0.3.3)
+      mime-types
+    vcr (2.0.1)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cloudapp-service!
+  rake
+  rspec
+  vcr (~> 2.0.0)
+  webmock

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Linebreak S.L.
+
+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,14 @@
+# CloudApp Ruby Client [![Build Status](https://secure.travis-ci.org/cloudapp/cloudapp.png)](http://travis-ci.org/cloudapp/cloudapp)
+
+Interact with the [CloudApp API][] from Ruby.
+
+[cloudapp api]: http://developer.getcloudapp.com
+
+## Requirements
+
+`cloudapp` requires Ruby 1.9.2 or greater.
+
+
+## Usage
+
+_Usage from Ruby is still a work in progress._

data/Rakefile

@@ -0,0 +1,148 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def primary_file
+  name.tr('-', '/')
+end
+
+def version
+  line = File.read("lib/#{primary_file}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+task RSpec::Core::RakeTask.new('spec')
+task :default => "spec"
+
+desc 'Run non-integration specs'
+RSpec::Core::RakeTask.new('spec:unit') do |t|
+  t.rspec_opts = "--tag ~integration"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => [:gemspec, :update_bundle] do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Update #{name} in bundle"
+task :update_bundle => :validate do
+  `bundle update #{name}`
+  puts "Bundled #{name} version #{version}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  service_files = ['lib/cloudapp',
+                   "lib/#{primary_file}",
+                   "lib/#{primary_file}.rb"]
+  collection_json_files = ['lib/cloudapp/collection_json',
+                           'lib/cloudapp/collection_json.rb']
+  libfiles = Dir['lib/*'] + Dir['lib/cloudapp/*'] -
+    service_files - collection_json_files
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{primary_file}.rb` file and `#{primary_file}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/cloudapp-service.gemspec

@@ -0,0 +1,115 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'cloudapp-service'
+  s.version           = '1.0.0.beta.1'
+  s.date              = '2012-10-08'
+  s.rubyforge_project = 'cloudapp-service'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "CloudApp API Client"
+  s.description = "CloudApp API Client"
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Larry Marburger"]
+  s.email    = 'larry@marburger.cc'
+  s.homepage = 'https://github.com/cloudapp/cloudapp.rb'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md MIT-LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  s.add_dependency 'leadlight', '~> 0.0.7'
+  s.add_dependency 'typhoeus',  '~> 0.3.3'
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'vcr', '~> 2.0.0'
+  s.add_development_dependency 'webmock'
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    CHANGELOG.md
+    Gemfile
+    Gemfile.lock
+    MIT-LICENSE
+    README.md
+    Rakefile
+    cloudapp-service.gemspec
+    lib/cloudapp/collection_json.rb
+    lib/cloudapp/collection_json/item.rb
+    lib/cloudapp/collection_json/representation.rb
+    lib/cloudapp/collection_json/template.rb
+    lib/cloudapp/collection_json/tint.rb
+    lib/cloudapp/service.rb
+    lib/cloudapp/service/authorized_representation.rb
+    lib/cloudapp/service/drop.rb
+    lib/cloudapp/service/drop_collection.rb
+    spec/cassettes/account_token.yml
+    spec/cassettes/create_bookmark.yml
+    spec/cassettes/create_bookmark_with_name.yml
+    spec/cassettes/create_bookmark_with_privacy.yml
+    spec/cassettes/delete_drop.yml
+    spec/cassettes/list_drops.yml
+    spec/cassettes/list_drops_with_bad_token.yml
+    spec/cassettes/list_drops_with_filter.yml
+    spec/cassettes/list_drops_with_limit.yml
+    spec/cassettes/privatize_drop.yml
+    spec/cassettes/publicize_drop.yml
+    spec/cassettes/purge_drops.yml
+    spec/cassettes/recover_drop.yml
+    spec/cassettes/rename_drop.yml
+    spec/cassettes/token_for_account.yml
+    spec/cassettes/token_for_account_with_bad_credentials.yml
+    spec/cassettes/trash_drop.yml
+    spec/cassettes/update_drop_bookmark_url.yml
+    spec/cassettes/update_file.yml
+    spec/cassettes/upload_file.yml
+    spec/cassettes/upload_file_with_name.yml
+    spec/cassettes/upload_file_with_privacy.yml
+    spec/cassettes/view_drop.yml
+    spec/cloudapp/authorized_representation_spec.rb
+    spec/cloudapp/collection_json/item_spec.rb
+    spec/cloudapp/collection_json/representation_spec.rb
+    spec/cloudapp/collection_json/template_spec.rb
+    spec/cloudapp/drop_collection_spec.rb
+    spec/cloudapp/drop_spec.rb
+    spec/cloudapp/service_spec.rb
+    spec/helper.rb
+    spec/integration_spec.rb
+    spec/support/files/favicon.ico
+    spec/support/stub_class_or_module.rb
+    spec/support/vcr.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  # s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/cloudapp/collection_json.rb

@@ -0,0 +1,3 @@
+require 'cloudapp/collection_json/item'
+require 'cloudapp/collection_json/representation'
+require 'cloudapp/collection_json/template'

data/lib/cloudapp/collection_json/item.rb

@@ -0,0 +1,20 @@
+require 'ostruct'
+
+module CloudApp
+  module CollectionJson
+    class Item
+      attr_reader :href, :links, :data
+      def initialize(item_data)
+        @href  = item_data.fetch('href',  nil)
+        @links = item_data.fetch('links', []).map {|link| OpenStruct.new(link) }
+        @data  = DataCollection.hash_from(item_data.fetch('data'))
+      end
+    end
+
+    class DataCollection
+      def self.hash_from(data)
+        Hash[data.map {|datum| [ datum['name'], datum['value'] ]}]
+      end
+    end
+  end
+end

data/lib/cloudapp/collection_json/representation.rb

@@ -0,0 +1,74 @@
+require 'ostruct'
+
+module CloudApp
+  module CollectionJson
+    module Representation
+      def href
+        collection.fetch('href')
+      end
+
+      def collection_links
+        return [] unless collection.has_key?('links')
+        collection.fetch('links').map {|link| OpenStruct.new(link) }
+      end
+
+      def items(item_source = default_item_source)
+        collection.fetch('items').map {|item|
+          item_source.call(item)
+        }
+      end
+
+      # Ultimately this API would be nice:
+      #
+      #   root.template(email: email, password: password).
+      #     post do |response|
+      #       return response
+      #     end
+      #
+      # The Command Pattern could be nice as well. Template#[] may be a better
+      # solution than faux methods.
+      #
+      #   root.create do |template|
+      #     template.email = email
+      #     template.password = password
+      #   end
+      #
+      # Updates also use the template.
+      #
+      #   root.items.first.update do |template|
+      #     template.name.reverse!
+      #   end
+      def template(template_source = default_template_source)
+        return unless collection.has_key?('template')
+        template_source.call collection.fetch('template')
+      end
+
+      def queries(query_source = default_query_source)
+        return unless collection.has_key?('queries')
+        collection.fetch('queries').map {|query| query_source.call(query) }
+      end
+
+      def query(rel, query_source = default_query_source)
+        Array(queries(query_source)).find {|query| query.rel == rel }
+      end
+
+    protected
+
+      def default_item_source
+        CloudApp::CollectionJson::Item.public_method(:new)
+      end
+
+      def default_template_source
+        CloudApp::CollectionJson::Template.public_method(:new)
+      end
+
+      def default_query_source
+        CloudApp::CollectionJson::Template.public_method(:new)
+      end
+
+      def collection
+        self.fetch('collection')
+      end
+    end
+  end
+end