RubyGems - jackie - Versions diffs - 0.0.2 → 0.0.3 - Mend

jackie 0.0.2 → 0.0.3

Files changed (13) hide show

data/.gitignore CHANGED

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .ruby-version
+test_root

data/.travis.yml ADDED

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx
+branches:
+  only:
+    - master
+matrix:
+  include:
+    - rvm: jruby
+      env: JRUBY_OPTS="--1.9 --server -Xcext.enabled=true"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="--1.9 --server -Xcext.enabled=true"
+before_script:
+  - rake fake_s3

data/Gemfile CHANGED

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in jackie.gemspec
 gemspec
+gem 'aws-s3'

data/README.md CHANGED

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/firebaseco/jackie.png?branch=master)](https://travis-ci.org/firebaseco/jackie)
 # Jackie
  A Ruby interface to the Kickfolio API.
@@ -25,37 +27,52 @@ Or install it yourself as:
 ```
 ### Basic Objects Operations
 ```ruby
-# Create New app
-app = Jackie::App.new(app_attributes)
+# Create a new app
+app = Jackie::App.new(:name => "Hello")
 app.save
-# Find the app with app_id 1.
+# Find the app with id 1.
 app = Jackie::App.find(1)
-app.name = "new name"
+app.name = "HelloWorld"
 app.save
-# GET the App versions
-app.versions
-# Delete a App
+# Delete an App
 app.destroy
-# GET the Apps
+# Get all the existing Apps
 Jackie::App.all
-# Create New App Version
-version = Jackie::Version.new(:app_id => app.id, :bundle_url => "https://bundle_url.com/myiosapp")
+# Create a new Version of an App
+version = Jackie::Version.new(:app_id => app.id, :bundle_url => "https://site.org/hello.app.zip")
 version.save
-# Find the version with version id 1.
+# Find the version with id 1.
 version = Jackie::Version.find(1)
-# GET All Versions
+# Get all the Versions
 Jackie::Version.all
+# GET all the Versions of an App
+app.versions
 # Delete a Version
 version.destroy
 ```
+### Jackie and AWS-S3
+The following is optional. You can use Jackie without S3 as seem above.
+```ruby
+# Set your AWS api keys
+Jackie.configure_s3({
+  :access_key_id => "YOUR ACCESS KEY ID",
+  :secret_access_key => "YOUR SECRET ACCESS KEY"
+}, {:bucket => "YOUR BUCKET"})
+# Usage
+version = Jackie::Version.new(:app_id => app.id, :file => "path/to/local/file.zip")
+version.save
+```
+For additional information read the [Kickfolio API docs](https://github.com/Kickfolio/ApiDocs)
 ## Contributing
 1. Fork it
@@ -68,4 +85,4 @@ License
 -------
 Jackie is Copyright © 2013 Firebase. It is free software,
-and may be redistributed under the terms specified in the MIT-LICENSE file.
+and may be redistributed under the terms specified in the LICENSE.txt file.

data/Rakefile CHANGED

@@ -13,6 +13,10 @@ task :help do
   puts "rake test - Run tests"
 end
+task :fake_s3 do
+  system "fakes3 --port 10453 --root test_root &"
+end
 task :test do
   Dir.chdir('test')
 end

data/jackie.gemspec CHANGED

@@ -1,11 +1,8 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jackie'
 Gem::Specification.new do |spec|
   spec.name          = "jackie"
-  spec.version       = Jackie::VERSION
+  spec.version       = "0.0.3"
   spec.authors       = ["Lacides Charris", "Guillermo Iguaran", "Roberto Miranda", "Firebase.co"]
   spec.email         = ["lacides@firebase.co", "guille@firebase.co", "roberto@firebase.co", "hello@firebase.co"]
   spec.description   = %q{A Ruby interface to the Kickfolio API.}
@@ -20,6 +17,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "fakes3"
-  spec.add_dependency "activeresource"
+  spec.add_dependency "activeresource", "~> 3.2.13"
 end

data/lib/jackie.rb CHANGED

@@ -3,11 +3,16 @@ require "active_resource"
 require "jackie/base"
 require "jackie/app"
 require "jackie/version"
+require "jackie/aws_uploader"
 module Jackie
-  VERSION = "0.0.2"
   def self.api_key=(api_key)
     Jackie::Base.api_key = api_key
   end
+  # So, it should be straightforward to add support for ftp or dropbox or whatever.
+  # By creating a uploader (with the public api of AWSUploader) and calling set_uploader with it
+  def self.configure_s3(connection_params, access_params)
+    Jackie::Version.set_uploader(Jackie::AWSUploader.new(connection_params, access_params))
+  end
 end

data/lib/jackie/aws_uploader.rb ADDED

@@ -0,0 +1,24 @@
+module Jackie
+  class AWSUploader
+    def initialize(connection_params, access_params)
+      load_dependency
+      AWS::S3::Base.establish_connection!(connection_params)
+      @config = access_params
+    end
+    def upload(file)
+      AWS::S3::S3Object.store(file, open(file), @config[:bucket])
+      AWS::S3::S3Object.url_for(file, @config[:bucket])
+    end
+    private
+    def load_dependency
+      begin
+        require "aws/s3"
+      rescue LoadError => e
+        $stderr.puts "You don't have aws/s3 installed in your application. Please add it to your Gemfile and run bundle install"
+        raise e
+      end
+    end
+  end
+end

data/lib/jackie/version.rb CHANGED

@@ -1,7 +1,20 @@
 module Jackie
   class Version < Base
+    cattr_accessor :uploader, :instance_writer => false
+    class << self
+      def set_uploader(uploader)
+        self.uploader = uploader
+      end
+    end
     def preview_url
       "http://kickfolio.com/v/#{app_id}/version/#{id}"
     end
+    def save
+      self.bundle_url = uploader.upload(attributes["file"]) if attributes["file"] && uploader
+      super
+    end
   end
-end
+end

data/test/app_test.rb CHANGED

@@ -11,6 +11,6 @@ class AppTest < MiniTest::Unit::TestCase
   end
   def test_versions
-    assert_kind_of ActiveResource::Collection, @app.versions
+    assert_kind_of Jackie::Version, @app.versions.first
   end
 end

data/test/test_helper.rb CHANGED

@@ -12,6 +12,20 @@ require "minitest/autorun"
 Jackie.api_key =  "MyKickfolioApiKey"
 class MiniTest::Unit::TestCase
+  def with_fake_s3
+    Jackie.configure_s3({
+      :access_key_id => "123",
+      :secret_access_key => "abc",
+      :server => "localhost",
+      :port => "10453"
+    }, {:bucket => "nuvado-test"})
+    yield
+  ensure
+    AWS::S3::Base.disconnect!
+    Jackie::Version.uploader = nil
+  end
   def self.mock_requests!
     # FIXME move to fixture module
     @app = { "id" => "1",
@@ -45,6 +59,7 @@ class MiniTest::Unit::TestCase
       mock.get "/api/apps/1.json", @headers, @app
       mock.get "/api/versions.json?app_id=1", @headers, [@version].to_json
       mock.get "/api/versions/1.json", @headers, @version.to_json
+      mock.post "/api/versions.json", @headers
     end
   end
 end

data/test/version_test.rb CHANGED

@@ -10,4 +10,30 @@ class VersionTest < MiniTest::Unit::TestCase
     assert_match @version.app_id, @version.preview_url
     assert_match @version.id, @version.preview_url
   end
+  def test_save_new_with_file
+    with_fake_s3 do
+      version = Jackie::Version.new(:app_id => 1, :file => File.basename(__FILE__))
+      version.save
+      assert_match /http:\/\/localhost:10453\/nuvado-test\/version_test\.rb/, version.bundle_url
+    end
+  end
+  def test_create_with_file
+    with_fake_s3 do
+      version = Jackie::Version.create(:app_id => 1, :file => File.basename(__FILE__))
+      assert_match /http:\/\/localhost:10453\/nuvado-test\/version_test\.rb/, version.bundle_url
+    end
+  end
+  def test_save_new_with_bundle_url
+    version = Jackie::Version.new(:app_id => 1, :bundle_url => "http://somewhere.in/the/cloud")
+    version.save
+    assert_equal "http://somewhere.in/the/cloud", version.bundle_url
+  end
+  def test_create_with_bundle_url
+    version = Jackie::Version.create(:app_id => 1, :bundle_url => "http://somewhere.in/the/cloud")
+    assert_equal "http://somewhere.in/the/cloud", version.bundle_url
+  end
 end

metadata CHANGED

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jackie
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease:
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -47,14 +47,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activeresource
+  name: fakes3
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -62,6 +62,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
 description: A Ruby interface to the Kickfolio API.
 email:
 - lacides@firebase.co
@@ -73,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -80,6 +97,7 @@ files:
 - jackie.gemspec
 - lib/jackie.rb
 - lib/jackie/app.rb
+- lib/jackie/aws_uploader.rb
 - lib/jackie/base.rb
 - lib/jackie/version.rb
 - test/app_test.rb