phone_gap-build 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eecaeb180ecb3f2c04f9dce4badb7857f7fe728d
-  data.tar.gz: d9d37fdebe1f87bb45ad18c4fd2a1cccec011b66
+  metadata.gz: 12844dadae8e2b81b176ddcf2d7b3f28d18403b9
+  data.tar.gz: 0593bbe7132d9c502057e7d2a5bdbc046f8d68c5
 SHA512:
-  metadata.gz: 8b794e509e9ef17ac0a028e21506fb4c7097c4a43fadc8b65472fbd5443ed9b87ec8ab0e9514e5292767c828603e71f89870061de5d4421298a630cdf8bbf883
-  data.tar.gz: 9cbf50b934de26a896352d6a0b479f60872ae942ff2cb9dd374c86f8530555b8d2ddcb5f5a392e37cc178cc988ef6fdd34f7b9a00d84023555deb473a7ff375d
+  metadata.gz: 7baeb0e1accd202d53dd2f1f143fffc27b27801a38f7df9d9e81fabf731141f1e54702fb6afbe59edd547cde74594c628c7220fab186a95310bf0ded95e00e9f
+  data.tar.gz: b66b04811b0acbd665c740b60ec5048e8027349d0d72ef6c7eaf8617c269c5d31a38d9ebbd278bc9878db918f78fe5041f83f6c1dc97a46da61ae483a10e95c3

data/README.md

@@ -26,8 +26,12 @@ Or install it yourself as:
 
     require 'phone_gap/build'
 
+    # manually set your api credentials
     PhoneGap::Build.credentials(token: 'my_api_token')
 
+    # credentials are autoloaded from config/phonegap.yml if it exists
+
+    # set what apps you got
     apps = PhoneGap::Build.apps
 
     # update an existing app
@@ -46,6 +50,12 @@ Or install it yourself as:
     # save/create the app
     app.save
 
+    # build the app
+    app.build
+
+    # check if the build is complete
+    app.build_complete?
+
     # delete it!
     app.destroy
 

data/lib/phone_gap/build/app.rb

@@ -27,6 +27,26 @@ module PhoneGap
       def build
         ApiRequest.new.post("#{PATH}/#{id}/build")
       end
+
+      def build_complete?(params = {})
+        complete = false
+        error = false
+        start_time = Time.now
+        time_limit = start_time + (params[:poll_time_limit] || poll_time_limit)
+        while !complete && (Time.now < time_limit) && !error
+          response = ApiRequest.new.get("#{PATH}/#{id}")
+          if response.success?
+            json_object = JSON.parse(response.body)
+            complete = json_object['status'].all? { |platform, status| status == 'complete' }
+            error = json_object['status'].any? { |platform, status| status == 'error' }
+          end
+          sleep (params[:poll_interval] || poll_interval) unless complete or error
+        end
+        raise BuildError.new('An error occurred building at least one of the apps.') if error
+        complete
+      end
     end
+
+    class BuildError < Exception ; end
   end
-end
+end

data/lib/phone_gap/build/rest_resource.rb

@@ -1,4 +1,5 @@
 require 'phone_gap/build/creatable'
+require 'phone_gap/build/base'
 
 module PhoneGap
   module Build
@@ -6,13 +7,24 @@ module PhoneGap
 
       include PhoneGap::Build::Creatable
       attr_reader :id
+      attr_accessor :poll_time_limit, :poll_interval
+      attr_writer :errors
+
+      def initialize(params = {})
+        @poll_time_limit = 120
+        @poll_interval = 5
+        super(params)
+      end
 
       def create
         response = ApiRequest.new.post(path, post_options)
         if response.success?
           populate_from_json(JSON.parse(response.body))
+          self
+        else
+          update_errors(JSON.parse(response.body))
+          false
         end
-        self
       end
 
       def update
@@ -39,6 +51,10 @@ module PhoneGap
         params[:remove_nils] ? json.delete_if {|k, v| v.nil? } : json
       end
 
+      def errors
+        @errors ||= []
+      end
+
       private
 
       def post_options
@@ -62,6 +78,10 @@ module PhoneGap
           end
         end
       end
+
+      def update_errors(json)
+        errors << json['error']
+      end
     end
   end
 end

data/lib/phone_gap/build/version.rb

@@ -1,5 +1,5 @@
 module PhoneGap
   module Build
-    VERSION = '0.4.0'
+    VERSION = '0.5.0'
   end
 end

data/spec/fixtures/api_responses/get-app.json

@@ -0,0 +1,52 @@
+{
+    "title": "PhoneGap: Getting Started",
+    "id": 2,
+    "package": "com.phonegap.getting.started",
+    "version": "1.0.0",
+    "repo": "https://github.com/phonegap/phonegap-start.git",
+    "description": "A template for getting started with PhoneGap development and build.phonegap.com",
+    "debug": false,
+    "private": true,
+    "link": "/api/v1/apps/2",
+    "build_count": 12,
+    "status": {
+        "android": "complete",
+        "ios": "complete",
+        "winphone": "complete"
+    },
+    "download": {
+        "android": "/api/v1/apps/1/android",
+        "ios": "/api/v1/apps/1/ios",
+        "winphone": "/api/v1/apps/1/winphone"
+    },
+    "error": {},
+    "icon": {
+        "filename": "big-icon.png",
+        "link": "/api/v1/apps/2/icon"
+    },
+    "role": "admin",
+    "keys": {},
+    "collaborators": {
+        "link": "/api/v1/apps/9/collaborators",
+        "active": [
+            {
+                "id": 9,
+                "person": "andrew.lunny@nitobi.com",
+                "role": "admin",
+                "link": "/api/v1/apps/9/collaborators/9"
+            },
+            {
+                "id": 13,
+                "person": "foo@bar.com",
+                "role": "developer",
+                "link": "/api/v1/apps/9/collaborators/13"
+            }
+        ],
+        "pending": [
+            {
+                "person": "nobody@nitobi.com",
+                "role": "tester"
+            }
+        ]
+    }
+}

data/spec/phone_gap/build/app_spec.rb

@@ -2,6 +2,12 @@ require 'spec_helper'
 
 describe PhoneGap::Build::App do
 
+  let(:api_request) { double('PhoneGap::Build::ApiRequest') }
+
+  before do
+    PhoneGap::Build::ApiRequest.stub(:new).and_return api_request
+  end
+
   it 'has a PATH of "apps"' do
     expect(subject.class.const_get('PATH')).to eq '/apps'
   end
@@ -30,8 +36,8 @@ describe PhoneGap::Build::App do
 
   describe '#create' do
 
-    let(:response) { double('response', :success? => false) }
     let(:api_request) { double('PhoneGap::Build::ApiRequest') }
+    let(:response) { double('response', :success? => false, body: '{"key":"value"}') }
 
     context 'when there are populated and non-populated creatable variables' do
 
@@ -66,16 +72,94 @@ describe PhoneGap::Build::App do
     end
   end
 
-  describe '#build' do
+  context 'for an existing app' do
+
+    let(:id) { '1' }
+
+    before do
+      subject.instance_variable_set('@id',id)
+    end
+
+    describe '#build' do
+
+      context 'when the app has an id' do
+
+        let(:id) { 1 }
+        let(:api_request) { double('PhoneGap::Build::ApiRequest') }
+
+        before do
+          subject.instance_variable_set('@id', id)
+        end
+
+        it 'sends a POST request to build the app' do
+          expect(api_request).to receive(:post).with("/apps/#{subject.id}/build")
+          subject.build
+        end
+      end
+    end
 
-    context 'when the app has an id' do
+    describe '#build_complete?' do
 
-      let(:id) { 1 }
-      let(:api_request) { double('PhoneGap::Build::ApiRequest') }
+      let(:http_response) { double('http response', success?: false) }
 
       before do
-        subject.instance_variable_set('@id', id)
-        PhoneGap::Build::ApiRequest.stub(:new).and_return api_request
+        api_request.stub(:get).with("/apps/#{id}").and_return http_response
+        subject.poll_time_limit = 0.1
+        subject.poll_interval = 0
+      end
+
+      it 'polls the api to see if the app has finished building' do
+        expect(api_request).to receive(:get).with("/apps/#{id}").and_return http_response
+        subject.build_complete?
+      end
+
+      context 'with a poll interval of 0.09 second' do
+
+        before do
+          subject.poll_interval = 0.09
+        end
+
+        context 'when not given a time limit' do
+
+          context 'with a poll interval of 0.1 seconds' do
+
+            before do
+              subject.poll_interval = 0.1
+            end
+
+            it 'checks every 0.09 seconds until the default time limit is exceeded' do
+              subject.poll_time_limit = 0.09
+              expect(api_request).to receive(:get).with("/apps/#{id}").exactly(1).times
+              subject.build_complete?
+            end
+          end
+        end
+
+        context 'when supplied with a time limit' do
+
+          it 'checks every 0.1 seconds until the supplied time limit has exceeded' do
+            expect(api_request).to receive(:get).with("/apps/#{id}").exactly(1).times
+            subject.build_complete?(poll_time_limit: 0.09)
+          end
+
+        end
+        context 'when the build is complete' do
+
+          let(:http_response) { double('http response', success?: true, body: response_body_for('get-app') ) }
+
+          it 'returns true' do
+            expect(subject.build_complete?).to be_true
+          end
+        end
+
+        context 'when there was an error building' do
+
+          let(:http_response) { double('http response', success?: true, body: '{"status": { "ios": "error"}}') }
+
+          it 'returns throws an exception' do
+            expect{subject.build_complete?}.to raise_error PhoneGap::Build::BuildError
+          end
+        end
       end
 
       it 'sends a POST request to build the app' do

data/spec/phone_gap/build/rest_resource_spec.rb

@@ -9,6 +9,14 @@ describe PhoneGap::Build::RestResource do
     PhoneGap::Build::ApiRequest.stub(:new).and_return api_request
   end
 
+  it 'has a default poll_time_limit of 120' do
+    expect(subject.poll_time_limit).to eq 120
+  end
+
+  it 'has a default poll_interval of 5' do
+    expect(subject.poll_interval).to eq 5
+  end
+
   context 'when an authentication token is present' do
 
     let(:token) { 'BATMAN' }
@@ -31,10 +39,10 @@ describe PhoneGap::Build::RestResource do
 
       describe '#create' do
 
-        let(:response) { double('response', success?: false) }
+        let(:response) { double('response', success?: false, body: '{"key": "value"}') }
 
         before do
-         # api_request.stub(:post).with('users', query: {data: subject.as_json}).and_return response
+         api_request.stub(:post).with('users', query: {data: subject.as_json}).and_return response
         end
 
         it 'sends POST request' do
@@ -69,9 +77,9 @@ describe PhoneGap::Build::RestResource do
           end
         end
 
-        context 'after successful creation' do
+        context 'when creation is successful' do
 
-          let(:success_response) { double('response', success?: true, body: '{"title" : "Batman", "rating" : 5}') }
+          let(:success_response) { double('response', success?: true, body: '{"id" : 1, "title" : "Batman", "rating" : 5}') }
 
           before do
             api_request.stub(:post).with('users', query: {data: {}}).and_return success_response
@@ -80,10 +88,25 @@ describe PhoneGap::Build::RestResource do
           it 'updates the object with any response attributes' do
             response = subject.create
             expect(response.object_id).to be subject.object_id
+            expect(response.instance_variable_get('@id')).to eq 1
             expect(response.instance_variable_get('@title')).to eq 'Batman'
             expect(response.instance_variable_get('@rating')).to eq 5
           end
         end
+
+        context 'when creation is unsuccessful' do
+
+          let(:response) { double('response', success?: false, body: "{\"error\":\"Error: upload failed; please try again\"}\n") }
+
+          it 'returns false' do
+            expect(subject.create).to eq false
+          end
+
+          it 'updates the object with the errors' do
+            subject.create
+            expect(subject.errors).to eq ['Error: upload failed; please try again']
+          end
+        end
       end
 
       describe '#update' do
@@ -135,7 +158,7 @@ describe PhoneGap::Build::RestResource do
 
         context 'when the child object doesn\'t have an id attribute' do
 
-          let(:http_response) { double('response', success?: false) }
+          let(:http_response) { double('response', success?: false, body: '{"key":"value"}') }
 
           before do
             subject.id = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phone_gap-build
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Seb Glazebrook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-20 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
@@ -104,6 +104,7 @@ files:
 - lib/phone_gap/build/rest_resource.rb
 - lib/phone_gap/build/version.rb
 - phone_gap-build.gemspec
+- spec/fixtures/api_responses/get-app.json
 - spec/fixtures/api_responses/get-apps.json
 - spec/fixtures/api_responses/rest-resource-create.json
 - spec/fixtures/index.html
@@ -139,6 +140,7 @@ signing_key:
 specification_version: 4
 summary: PhoneGap Build Api gem
 test_files:
+- spec/fixtures/api_responses/get-app.json
 - spec/fixtures/api_responses/get-apps.json
 - spec/fixtures/api_responses/rest-resource-create.json
 - spec/fixtures/index.html