phone_gap-build 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7d9c20c29ac0055691fac9fabb28e826f8f4886
-  data.tar.gz: a62b82a3c032051c18b30335440c1b6bafb3a28c
+  metadata.gz: eecaeb180ecb3f2c04f9dce4badb7857f7fe728d
+  data.tar.gz: d9d37fdebe1f87bb45ad18c4fd2a1cccec011b66
 SHA512:
-  metadata.gz: b97eac4703677d6f6840ca14902520f82e4872d9e514f9d23a419b0b1bdccc9223ae62229d246002b80abb904f024f4deb95dbecf57f9b64cb2d1b8e760b5aa4
-  data.tar.gz: 20294eb0791f250b3916e1136b6c1fdc8f21485a7d1f5ff7b6d9b7612631379c7ede10e78ccc2a1ed5d734b80012ddf23bbdbfdd3444cedfc0dce95ac8b27d86
+  metadata.gz: 8b794e509e9ef17ac0a028e21506fb4c7097c4a43fadc8b65472fbd5443ed9b87ec8ab0e9514e5292767c828603e71f89870061de5d4421298a630cdf8bbf883
+  data.tar.gz: 9cbf50b934de26a896352d6a0b479f60872ae942ff2cb9dd374c86f8530555b8d2ddcb5f5a392e37cc178cc988ef6fdd34f7b9a00d84023555deb473a7ff375d

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p451

data/README.md

@@ -30,24 +30,23 @@ Or install it yourself as:
 
     apps = PhoneGap::Build.apps
 
-    # get the app you're interested in
-
+    # update an existing app
     app = apps.first
-
     app.description = 'Fancy Pants App'
-
-    app.save (#save will update an existing app)
+    app.save
 
     # create a new app
-
     app = PhoneGap::Build::App.new
 
     # add any required values (see http://docs.build.phonegap.com/en_US/3.3.0/developer_api_api.md.html#PhoneGap%20Build%20Developer%20API)
+    app.title = 'Batman'
+    app.create_method = 'file'
+    app.file = File.new('./batman-files/gotham.city')
 
-    app.save (#save create a new app)
+    # save/create the app
+    app.save
 
     # delete it!
-
     app.destroy
 
 ## Contributing

data/lib/phone_gap/build/api_request.rb

@@ -0,0 +1,60 @@
+module PhoneGap
+  module Build
+    class ApiRequest
+
+      include HTTMultiParty
+      base_uri 'https://build.phonegap.com/api/v1'
+
+      def get(path)
+        if credentials?
+          self.class.get("#{path}?auth_token=#{token}")
+        else
+          credentials_not_found
+        end
+      end
+
+      def post(path, params = {})
+        if credentials?
+          self.class.post("#{path}?auth_token=#{token}", query: params[:query])
+        else
+          credentials_not_found
+        end
+      end
+
+      def put(path, params = {})
+        if credentials?
+          self.class.put("#{path}?auth_token=#{token}", query: params[:query])
+        else
+          credentials_not_found
+        end
+      end
+
+      def delete(path, params = {})
+        if credentials?
+          self.class.delete("#{path}?auth_token=#{token}")
+        else
+          credentials_not_found
+        end
+      end
+
+      private
+
+      def credentials?
+        if PhoneGap::Build::Credentials.instance.token
+          true
+        else
+          Credentials.instance.load
+          PhoneGap::Build::Credentials.instance.token
+        end
+      end
+
+      def credentials_not_found
+        Error.new(message: 'Api credentials not found. Set them or add them to config/phonegap.yml')
+      end
+
+      def token
+        PhoneGap::Build::Credentials.instance.token
+      end
+    end
+  end
+end

data/lib/phone_gap/build/app.rb

@@ -23,6 +23,10 @@ module PhoneGap
           {query: {data: as_json(only: creatable_attributes, remove_nils: true)}}
         end
       end
+
+      def build
+        ApiRequest.new.post("#{PATH}/#{id}/build")
+      end
     end
   end
 end

data/lib/phone_gap/build/base.rb

@@ -0,0 +1,13 @@
+module PhoneGap
+  module Build
+    class Base
+
+      def initialize(attributes = {})
+        attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+    end
+  end
+end

data/lib/phone_gap/build/credentials.rb

@@ -6,7 +6,7 @@ module PhoneGap
 
       include Singleton
 
-      attr_reader :username, :password, :token
+      attr_reader :username, :password, :token, :config
       attr_writer :token
 
       def set(credentials)
@@ -15,6 +15,15 @@ module PhoneGap
         @token = credentials[:token]
         self
       end
+
+      def load
+        config_file = File.expand_path('../../../../config/phonegap.yml', __FILE__)
+        if File.exists? config_file
+          @config = YAML::load_file(config_file)
+          @token = @config['token']
+        end
+        self
+      end
     end
   end
-end
+end

data/lib/phone_gap/build/error.rb

@@ -0,0 +1,11 @@
+module PhoneGap
+  module Build
+    class Error < Base
+
+      attr_reader :message
+
+
+
+    end
+  end
+end

data/lib/phone_gap/build/rest_resource.rb

@@ -1,22 +1,14 @@
 require 'phone_gap/build/creatable'
-require 'httmultiparty'
 
 module PhoneGap
   module Build
-    class RestResource
+    class RestResource < Base
 
       include PhoneGap::Build::Creatable
-      include HTTMultiParty
-      base_uri 'https://build.phonegap.com/api/v1'
-
-      def initialize(attributes = {})
-        attributes.each do |key, value|
-          instance_variable_set("@#{key}", value)
-        end
-      end
+      attr_reader :id
 
       def create
-        response = self.class.post(path, post_options)
+        response = ApiRequest.new.post(path, post_options)
         if response.success?
           populate_from_json(JSON.parse(response.body))
         end
@@ -24,7 +16,7 @@ module PhoneGap
       end
 
       def update
-        self.class.put(path, query: {data: as_json(only: updatable_attributes)})
+        ApiRequest.new.put(path, query: {data: as_json(only: updatable_attributes)})
       end
 
       def save
@@ -32,7 +24,7 @@ module PhoneGap
       end
 
       def destroy
-        self.class.delete(path)
+        ApiRequest.new.delete(path)
       end
 
       def as_json(params = {})
@@ -54,7 +46,7 @@ module PhoneGap
       end
 
       def path
-        @id ? "#{self.class.const_get('PATH')}/#{@id}?auth_token=#{token}" : "#{self.class.const_get('PATH')}?auth_token=#{token}"
+        @id ? "#{self.class.const_get('PATH')}/#{@id}" : "#{self.class.const_get('PATH')}"
       end
 
       def token

data/lib/phone_gap/build/version.rb

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

data/lib/phone_gap/build.rb

@@ -1,9 +1,12 @@
 require 'phone_gap/build/version'
+require 'phone_gap/build/base'
 require 'phone_gap/build/credentials'
 require 'phone_gap/build/app_factory'
 require 'phone_gap/build/app'
+require 'phone_gap/build/api_request'
 require 'phone_gap/build/rest_resource'
 require 'phone_gap/build/creatable'
+require 'phone_gap/build/error'
 
 require 'httparty'
 
@@ -15,10 +18,21 @@ module PhoneGap
     end
 
     def self.apps
-      http_response = HTTParty.get("https://build.phonegap.com/api/v1/apps?auth_token=#{@credentials.token}")
-      parsed_response = JSON.parse(http_response.body)
-      AppFactory.create_many(parsed_response)
+      if credentials?
+        http_response = HTTParty.get("https://build.phonegap.com/api/v1/apps?auth_token=#{@credentials.token}")
+        parsed_response = JSON.parse(http_response.body)
+        AppFactory.create_many(parsed_response)
+      else
+        Error.new(message: 'Api credentials not found. Set them or add thmem to config/phonegap.yml')
+      end
     end
 
+    def self.credentials?
+      if @credentials && @credentials.token
+        true
+      else
+        Credentials.instance.load
+      end
+    end
   end
 end

data/spec/phone_gap/build/api_request_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe PhoneGap::Build::ApiRequest do
+
+  describe 'checking that configuration exists before sending a request' do
+
+    %w(get post put delete).each do |request_action|
+
+      describe "##{request_action}" do
+
+        context 'without configuration set' do
+
+          let(:credentials) { double( 'Credentials', token: false) }
+
+          before do
+            PhoneGap::Build::Credentials.stub(:instance).and_return credentials
+          end
+
+          it 'looks for credentials configuration' do
+            expect(credentials).to receive(:load).and_return credentials
+            subject.send request_action, 'path'
+          end
+
+          context 'when credentials configuration exists' do
+
+            before do
+              credentials.stub(:load).and_return credentials
+              credentials.stub(:token).and_return 'BATMAN TOKEN'
+            end
+
+            it 'makes the api call' do
+              expect(subject.class).to receive(request_action.to_sym)
+              subject.send request_action, 'path'
+            end
+          end
+
+          context 'when credentials configuration does not exist' do
+
+            before do
+              credentials.stub(:load).and_return false
+            end
+
+            it 'returns an error' do
+              expect(subject.send(request_action, 'path').message).to eq 'Api credentials not found. Set them or add them to config/phonegap.yml'
+            end
+          end
+        end
+      end
+    end
+  end
+
+  context 'when credentials exist' do
+
+    let(:token) { 'BATMAN' }
+
+    before do
+      PhoneGap::Build::Credentials.instance.set(token: token)
+    end
+
+    describe '#get' do
+
+      it 'sends a GET request to the given path with the auth_token included' do
+        expect(subject.class).to receive(:get).with('some fancy path?auth_token=BATMAN')
+        subject.get('some fancy path')
+      end
+    end
+
+    describe '#post' do
+
+      it 'sends a POST request to the given path with the auth_token included' do
+        expect(subject.class).to receive(:post).with('some fancy path?auth_token=BATMAN', anything)
+        subject.post('some fancy path')
+      end
+
+      context 'when query params are available' do
+
+        let(:query_params) { { data: {id: 1, title: 'seb'}} }
+
+        it 'sends them through with the request' do
+          expect(subject.class).to receive(:post).with(anything, query: query_params)
+          subject.post('some fancy path', query: query_params)
+        end
+      end
+    end
+
+    describe '#put' do
+
+      it 'send a PUT request to the given path with the auth_token included' do
+        expect(subject.class).to receive(:put).with('some fancy path?auth_token=BATMAN', anything)
+        subject.put('some fancy path')
+      end
+
+      context 'when query params are available' do
+
+        let(:query_params) { { data: {id: 1, title: 'seb'}} }
+
+        it 'sends them through with the request' do
+          expect(subject.class).to receive(:put).with(anything, query: query_params)
+          subject.put('some faNCY PATH', query: query_params)
+        end
+      end
+    end
+
+    describe '#delete' do
+
+      it 'send a DELETE request to the given path with the auth_token included' do
+        expect(subject.class).to receive(:delete).with('some fancy path?auth_token=BATMAN')
+        subject.delete('some fancy path')
+      end
+    end
+  end
+end

data/spec/phone_gap/build/app_spec.rb

@@ -31,6 +31,7 @@ describe PhoneGap::Build::App do
   describe '#create' do
 
     let(:response) { double('response', :success? => false) }
+    let(:api_request) { double('PhoneGap::Build::ApiRequest') }
 
     context 'when there are populated and non-populated creatable variables' do
 
@@ -38,11 +39,12 @@ describe PhoneGap::Build::App do
         subject.title = 'title'
         subject.create_method = 'create method'
         subject.package = nil
+        PhoneGap::Build::ApiRequest.stub(:new).and_return api_request
       end
 
       it 'sends query data for all creatable attributes that do not have a value of nil' do
         expected_options = { query: {data: { title: 'title', create_method: 'create method'}}}
-        expect(subject.class).to receive(:post).with(anything, expected_options ).and_return response
+        expect(api_request).to receive(:post).with(anything, expected_options).and_return response
         subject.create
       end
 
@@ -57,10 +59,29 @@ describe PhoneGap::Build::App do
         it 'sends the file through as part of the query' do
           expected_options =
               { query: { file: file, data: {title: 'title', create_method: 'create method'}}, detect_mime_type: true}
-          expect(subject.class).to receive(:post).with(anything, expected_options).and_return response
+          expect(api_request).to receive(:post).with(anything, expected_options).and_return response
           subject.create
         end
       end
     end
   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)
+        PhoneGap::Build::ApiRequest.stub(:new).and_return api_request
+      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
 end

data/spec/phone_gap/build/credentials_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe PhoneGap::Build::Credentials do
+
+  subject { PhoneGap::Build::Credentials .instance }
+
+  describe '#load' do
+
+    let(:config_file) { File.expand_path('config/phonegap.yml', ROOT_DIR) }
+
+    before do
+      File.stub(:exists?).with(config_file).and_return true
+    end
+
+    it 'tries to load a phonegap config file' do
+      expect(YAML).to receive(:load_file).with(config_file).and_return({})
+      subject.load
+    end
+
+    context 'if a config file exists' do
+
+      before do
+        YAML.stub(:load_file).and_return({'token' => 'BATMAN'})
+      end
+
+      it 'populates the credentials using values from the config file' do
+        subject.load
+        expect(subject.token).to eq 'BATMAN'
+      end
+    end
+  end
+end

data/spec/phone_gap/build/rest_resource_spec.rb

@@ -3,6 +3,11 @@ require 'spec_helper'
 describe PhoneGap::Build::RestResource do
 
   let(:base_uri) { 'https://build.phonegap.com/api/v1/' }
+  let(:api_request) { double('ApiRequest') }
+
+  before do
+    PhoneGap::Build::ApiRequest.stub(:new).and_return api_request
+  end
 
   context 'when an authentication token is present' do
 
@@ -29,16 +34,16 @@ describe PhoneGap::Build::RestResource do
         let(:response) { double('response', success?: false) }
 
         before do
-          subject.class.stub(:post).with("users?auth_token=#{token}", 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
-          expect(subject.class).to receive(:post).and_return response
+          expect(api_request).to receive(:post).and_return response
           subject.create
         end
 
         it 'uses the resource base as the path and includes the auth token in the request' do
-          expect(subject.class).to receive(:post).with("users?auth_token=#{token}", anything()).and_return response
+          expect(api_request).to receive(:post).with("users", anything).and_return response
           subject.create
         end
 
@@ -51,7 +56,7 @@ describe PhoneGap::Build::RestResource do
           end
 
           it 'posts using options from the child class' do
-            expect(subject.class).to receive(:post).with(anything, 'wonder woman').and_return response
+            expect(api_request).to receive(:post).with(anything, 'wonder woman').and_return response
             subject.create
           end
         end
@@ -59,7 +64,7 @@ describe PhoneGap::Build::RestResource do
         context 'child class does not have #post_options' do
 
           it 'sends a body containing all the json representation of the object' do
-            expect(subject.class).to receive(:post).with(anything, query: {data: subject.as_json}).and_return response
+            expect(api_request).to receive(:post).with(anything, query: {data: subject.as_json}).and_return response
             subject.create
           end
         end
@@ -69,7 +74,7 @@ describe PhoneGap::Build::RestResource do
           let(:success_response) { double('response', success?: true, body: '{"title" : "Batman", "rating" : 5}') }
 
           before do
-            subject.class.stub(:post).with("users?auth_token=#{token}", query: {data: {}}).and_return success_response
+            api_request.stub(:post).with('users', query: {data: {}}).and_return success_response
           end
 
           it 'updates the object with any response attributes' do
@@ -92,17 +97,17 @@ describe PhoneGap::Build::RestResource do
           end
 
           it 'sends PUT request' do
-            expect(subject.class).to receive(:put)
+            expect(api_request).to receive(:put)
             subject.update
           end
 
           it 'uses the resource base as the path and includes the auth token in the request' do
-            expect(subject.class).to receive(:put).with("users/#{id}?auth_token=#{token}", anything())
+            expect(api_request).to receive(:put).with("users/#{id}", anything)
             subject.update
           end
 
           it 'send a body containing all the json representation of the object' do
-            expect(subject.class).to receive(:put).with(anything(), query: {data: {}})
+            expect(api_request).to receive(:put).with(anything, query: {data: {}})
             subject.update
           end
 
@@ -123,7 +128,7 @@ describe PhoneGap::Build::RestResource do
           end
 
           it 'attempts to update an existing item' do
-            expect(subject.class).to receive(:put)
+            expect(api_request).to receive(:put)
             subject.save
           end
         end
@@ -134,11 +139,10 @@ describe PhoneGap::Build::RestResource do
 
           before do
             subject.id = nil
-            subject.class.stub(:post).and_return http_response
           end
 
           it 'attempts to create a new item' do
-            expect(subject.class).to receive(:post)
+            expect(api_request).to receive(:post).and_return http_response
             subject.save
           end
         end
@@ -155,12 +159,12 @@ describe PhoneGap::Build::RestResource do
           end
 
           it 'sends DELETE request' do
-            expect(subject.class).to receive(:delete)
+            expect(api_request).to receive(:delete)
             subject.destroy
           end
 
           it 'includes the auth token in the request' do
-            expect(subject.class).to receive(:delete).with("users/#{id}?auth_token=#{token}")
+            expect(api_request).to receive(:delete).with("users/#{id}")
             subject.destroy
           end
 

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'rspec'
 require_relative '../lib/phone_gap/build'
 
-ROOT_DIR = Pathname.new(File.expand_path('..', __FILE__))
+ROOT_DIR = Pathname.new(File.expand_path('../..', __FILE__))
 
 Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}
 

data/spec/support/fixtures.rb

@@ -1,10 +1,10 @@
 require 'json'
 
 def response_body_for(request)
-  fixture_file = File.open(ROOT_DIR + "fixtures/api_responses/#{request}.json")
+  fixture_file = File.open(ROOT_DIR + "spec/fixtures/api_responses/#{request}.json")
   File.read(fixture_file)
 end
 
 def fixture_file(filename)
-  File.new(ROOT_DIR + "fixtures/#{filename}")
+  File.new(ROOT_DIR + "spec/fixtures/#{filename}")
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: phone_gap-build
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Seb Glazebrook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httmultiparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: ''
@@ -87,23 +87,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .ruby-version
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/phone_gap/build.rb
+- lib/phone_gap/build/api_request.rb
 - lib/phone_gap/build/app.rb
 - lib/phone_gap/build/app_factory.rb
+- lib/phone_gap/build/base.rb
 - lib/phone_gap/build/creatable.rb
 - lib/phone_gap/build/credentials.rb
+- lib/phone_gap/build/error.rb
 - lib/phone_gap/build/rest_resource.rb
 - lib/phone_gap/build/version.rb
 - phone_gap-build.gemspec
 - spec/fixtures/api_responses/get-apps.json
 - spec/fixtures/api_responses/rest-resource-create.json
 - spec/fixtures/index.html
+- spec/phone_gap/build/api_request_spec.rb
 - spec/phone_gap/build/app_spec.rb
+- spec/phone_gap/build/credentials_spec.rb
 - spec/phone_gap/build/rest_resource_spec.rb
 - spec/phone_gap/build_spec.rb
 - spec/spec_helper.rb
@@ -118,17 +124,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: PhoneGap Build Api gem
@@ -136,7 +142,9 @@ test_files:
 - spec/fixtures/api_responses/get-apps.json
 - spec/fixtures/api_responses/rest-resource-create.json
 - spec/fixtures/index.html
+- spec/phone_gap/build/api_request_spec.rb
 - spec/phone_gap/build/app_spec.rb
+- spec/phone_gap/build/credentials_spec.rb
 - spec/phone_gap/build/rest_resource_spec.rb
 - spec/phone_gap/build_spec.rb
 - spec/spec_helper.rb