phone_gap-build 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: def3c1fe04ee9c71d97860ca06ada7b491b720e5
-  data.tar.gz: 13040e4d4859a256fd9abecf9cd8a05c2a7256c1
+  metadata.gz: 899a79a1f62e5235bc0f9a1f216d3a9bbd72ca89
+  data.tar.gz: 704aaa02c1219ff6077c4fd37c7201a81ff15d7c
 SHA512:
-  metadata.gz: 0b65111712fdfe2bed7ee68ad7cf3e7193c97920582011b9550f206a49338b5f5181d922bd0e3909fab29298a1761210ab0aadf8f95bf202476d5bc3e97d4d0a
-  data.tar.gz: 3981955216cfa781999ce4130fea294520621d5206230236533719d13ecce85040d17d1ef7427762bddb401b6c8cecd92ea430ccca3041d4e97fc4420340e9a9
+  metadata.gz: 00e0094338041ae7785c8b943eea9747e259b9922a19407d5ca5f1fd2867aae0cb4ef98608d721ac43e4d80d8dc18d5dc03b914c2679efae4c1b9571c5e3103d
+  data.tar.gz: 2060ab63c6e1b05228f38ca2323b420100a41f01a6d709e7f52e4e6f3c64131091a79d3e0fc8df20ef140812486e7343a03373e52dc8a362f83957197c01402a

data/README.md

@@ -24,11 +24,31 @@ Or install it yourself as:
 
 ## Usage
 
-require 'phone_gap/build'
+    require 'phone_gap/build'
 
-PhoneGap::Build.credentials(token: 'my_api_token')
+    PhoneGap::Build.credentials(token: 'my_api_token')
 
-apps = PhoneGap::Build.apps
+    apps = PhoneGap::Build.apps
+
+    # get the app you're interested in
+
+    app = apps.first
+
+    app.description = 'Fancy Pants App'
+
+    app.save (#save will update an existing app)
+
+    # 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.save (#save create a new app)
+
+    # delete it!
+
+    app.destroy
 
 ## Contributing
 

data/lib/phone_gap/build/app.rb

@@ -1,14 +1,15 @@
+require 'phone_gap/build/rest_resource'
+require 'httmultiparty'
+
 module PhoneGap
   module Build
-    class App
-
-      def initialize(params)
-        params.each do |key, value|
-          instance_variable_set("@#{key}", value)
-          singleton_class.class_eval { attr_accessor key }
-        end
-      end
-    end
+    class App < RestResource
+
+      PATH = '/apps'
+      attr_creatable :title, :create_method, :package, :version, :description, :debug, :keys, :private, :phonegap_version, :hydrates
+      attr_updatable :title, :package, :version, :description, :debug, :private, :phonegap_version
 
+
+    end
   end
 end

data/lib/phone_gap/build/creatable.rb

@@ -0,0 +1,41 @@
+module PhoneGap
+  module Build
+    module Creatable
+
+      self.class_variable_set('@@creatable_attributes', {})
+      self.class_variable_set('@@updatable_attributes', {})
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def creatable_attributes
+        self.class.class_variable_get('@@creatable_attributes')[self.class]
+      end
+
+      def updatable_attributes
+        self.class.class_variable_get('@@updatable_attributes')[self.class]
+      end
+
+      module ClassMethods
+
+        def attr_creatable(*args)
+          args.each { |attribute| add_to_collection('@@creatable_attributes', attribute) }
+        end
+
+        def attr_updatable(*args)
+          args.each { |attribute| add_to_collection('@@updatable_attributes', attribute) }
+        end
+
+        def add_to_collection(collection_name, value)
+          if self.class_variable_get(collection_name)[self]
+            self.class_variable_get(collection_name)[self] << "@#{value}"
+          else
+            self.class_variable_get(collection_name)[self] = ["@#{value}"]
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/phone_gap/build/credentials.rb

@@ -1,11 +1,19 @@
+require 'singleton'
+
 module PhoneGap
   module Build
     class Credentials
 
+      include Singleton
+
       attr_reader :username, :password, :token
+      attr_writer :token
 
-      def initialize(params)
-        @username, @password, @token = params[:username], params[:password], params[:token]
+      def set(credentials)
+        @username = credentials[:username]
+        @password = credentials[:password]
+        @token = credentials[:token]
+        self
       end
     end
   end

data/lib/phone_gap/build/rest_resource.rb

@@ -0,0 +1,63 @@
+require 'phone_gap/build/creatable'
+require 'httmultiparty'
+
+module PhoneGap
+  module Build
+    class RestResource
+
+      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
+
+      def create
+        response = self.class.post(path, query: {data: as_json(only: creatable_attributes)})
+        if response.success?
+          populate_from_json(JSON.parse(response.body))
+        end
+      end
+
+      def update
+        self.class.put(path, query: {data: as_json(only: updatable_attributes)})
+      end
+
+      def save
+        @id ? update : create
+      end
+
+      def destroy
+        self.class.delete(path)
+      end
+
+      def as_json(params = {})
+        if params[:only]
+          params[:only].inject({}) do | memo, attribute_name|
+            memo[attribute_name[1..-1].to_sym] = instance_variable_get(attribute_name)
+            memo
+          end
+        else
+          {}
+        end
+      end
+
+      private
+
+      def path
+        @id ? "#{self.class.const_get('PATH')}/#{@id}?auth_token=#{token}" : "#{self.class.const_get('PATH')}?auth_token=#{token}"
+      end
+
+      def token
+        PhoneGap::Build::Credentials.instance.token
+      end
+
+      def populate_from_json(json)
+        self.class.new(json)
+      end
+    end
+  end
+end

data/lib/phone_gap/build/version.rb

@@ -1,5 +1,5 @@
 module PhoneGap
   module Build
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

data/lib/phone_gap/build.rb

@@ -2,6 +2,8 @@ require 'phone_gap/build/version'
 require 'phone_gap/build/credentials'
 require 'phone_gap/build/app_factory'
 require 'phone_gap/build/app'
+require 'phone_gap/build/rest_resource'
+require 'phone_gap/build/creatable'
 
 require 'httparty'
 
@@ -9,7 +11,7 @@ module PhoneGap
   module Build
 
     def self.credentials(credentials)
-      @credentials = Credentials.new(credentials)
+      @credentials = Credentials.instance.set(credentials)
     end
 
     def self.apps

data/phone_gap-build.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'httparty'
+  spec.add_dependency 'httmultiparty'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

data/spec/fixtures/api_responses/rest-resource-create.json

@@ -0,0 +1,46 @@
+{
+    "keys": {
+        "ios": {
+            "title": "ios-key",
+            "default": true,
+            "id": 2,
+            "link": "/api/v1/keys/ios/2"
+        },
+        "android": {
+            "title": "release-key",
+            "default": true,
+            "id": 2,
+            "link": "/api/v1/keys/android/2"
+        }
+    },
+    "download": {},
+    "title": "API V1 App",
+    "repo": null,
+    "collaborators": [
+        {
+            "person": "andrew.lunny@nitobi.com",
+            "role": "admin"
+        }
+    ],
+    "role": "admin",
+    "id": 26486,
+    "icon": {
+        "filename": null,
+        "link": "/api/v1/apps/26486/icon"
+    },
+    "package": "com.alunny.apiv1",
+    "version": "0.1.0",
+    "description": null,
+    "debug": false,
+    "private": true,
+    "link": "/api/v1/apps/26486",
+    "status": {
+        "ios": "pending",
+        "android": "pending",
+        "winphone": "pending"
+    },
+    "error": {},
+    "phonegap_version": "2.9.0",
+    "hydrates": false,
+    "build_count": null
+}

data/spec/phone_gap/build/app_spec.rb

@@ -2,20 +2,28 @@ require 'spec_helper'
 
 describe PhoneGap::Build::App do
 
-  describe 'upon instantiation' do
+  it 'has a PATH of "apps"' do
+    expect(subject.class.const_get('PATH')).to eq '/apps'
+  end
+
+  describe 'creatable attributes' do
 
-    context 'when given parameters' do
+    subject { PhoneGap::Build::App }
 
-      let(:params) do
-        { name: 'Batman', title: 'Dark Knight', status: { height: 'tall', weight: 'heavy'} }
+    %w(title create_method package version description debug keys private phonegap_version hydrates).each do |attribute|
+      it "'#{attribute}' is updatable" do
+        expect(subject.class_variable_get('@@creatable_attributes')[subject]).to include "@#{attribute}"
       end
+    end
+  end
+
+  describe 'updatable attributes' do
 
-      subject { PhoneGap::Build::App.new(params) }
+    subject { PhoneGap::Build::App }
 
-      it 'makes an attribute of each parameter' do
-        expect(subject.name).to eq 'Batman'
-        expect(subject.title).to eq 'Dark Knight'
-        expect(subject.status).to eq({height: 'tall', weight: 'heavy'})
+    %w(title package version description debug private phonegap_version).each do |attribute|
+      it "'#{attribute}' is updatable" do
+        expect(subject.class_variable_get('@@updatable_attributes')[subject]).to include "@#{attribute}"
       end
     end
   end

data/spec/phone_gap/build/rest_resource_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+describe PhoneGap::Build::RestResource do
+
+  let(:base_uri) { 'https://build.phonegap.com/api/v1/' }
+
+  context 'when an authentication token is present' do
+
+    let(:token) { 'BATMAN' }
+
+    before do
+      PhoneGap::Build::Credentials.instance.token = token
+    end
+
+    context 'when used in a child class' do
+
+      class Child < PhoneGap::Build::RestResource
+
+        attr_accessor :id
+
+        PATH = 'users'
+
+      end
+
+      subject { Child.new }
+
+      describe '#create' 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
+        end
+
+        it 'sends POST request' do
+          expect(subject.class).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
+          subject.create
+        end
+
+          it 'sends a body containing all the json representation of the object' do
+            expect(subject.class).to receive(:post).with(anything(), query: {data: {}}).and_return response
+            subject.create
+          end
+
+        context 'after successful creation' 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
+          end
+
+          it 'updates the object with any response attributes' do
+            response = subject.create
+            expect(response).to be_kind_of Child
+            expect(response.instance_variable_get('@title')).to eq 'Batman'
+            expect(response.instance_variable_get('@rating')).to eq 5
+          end
+        end
+      end
+
+      describe '#update' do
+
+        context 'when the object has an id' do
+
+          let(:id) { double('id') }
+
+          before do
+            subject.id = id
+          end
+
+          it 'sends PUT request' do
+            expect(subject.class).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())
+            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: {}})
+            subject.update
+          end
+
+          context 'after successful update' do
+
+            it 'returns the populated object'
+
+          end
+        end
+      end
+
+      describe '#save' do
+
+        context 'when the child object has an id attribute' do
+
+          before do
+            subject.id = 69
+          end
+
+          it 'attempts to update an existing item' do
+            expect(subject.class).to receive(:put)
+            subject.save
+          end
+        end
+
+        context 'when the child object doesn\'t have an id attribute' do
+
+          let(:http_response) { double('response', success?: false) }
+
+          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)
+            subject.save
+          end
+        end
+      end
+
+      describe '#destroy' do
+
+        context 'when the object has an id' do
+
+          let(:id) { double('id') }
+
+          before do
+            subject.id = id
+          end
+
+          it 'sends DELETE request' do
+            expect(subject.class).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}")
+            subject.destroy
+          end
+
+          context 'upon successful deletion' do
+
+            it 'does something'
+
+          end
+        end
+
+        context 'when the object does not have an id' do
+
+          it 'returns an error'
+
+        end
+      end
+
+      describe '#as_json' do
+
+        context 'when there are instance variables' do
+
+          before do
+            subject.instance_variable_set('@superman', 'superman')
+            subject.instance_variable_set('@spiderman', 'spiderman')
+            subject.instance_variable_set('@batman', 'batman')
+          end
+
+          context 'when given a list of variables to use' do
+
+            let(:attributes) { ['@superman', '@spiderman'] }
+
+            it 'returns a hash of the given attributes and their values' do
+              expect(subject.as_json(only: attributes)).to eq({superman: 'superman', spiderman: 'spiderman'})
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: phone_gap-build
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Seb Glazebrook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: httmultiparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,11 +95,15 @@ files:
 - lib/phone_gap/build.rb
 - lib/phone_gap/build/app.rb
 - lib/phone_gap/build/app_factory.rb
+- lib/phone_gap/build/creatable.rb
 - lib/phone_gap/build/credentials.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/phone_gap/build/app_spec.rb
+- spec/phone_gap/build/rest_resource_spec.rb
 - spec/phone_gap/build_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb
@@ -129,7 +133,9 @@ specification_version: 4
 summary: PhoneGap Build Api gem
 test_files:
 - spec/fixtures/api_responses/get-apps.json
+- spec/fixtures/api_responses/rest-resource-create.json
 - spec/phone_gap/build/app_spec.rb
+- spec/phone_gap/build/rest_resource_spec.rb
 - spec/phone_gap/build_spec.rb
 - spec/spec_helper.rb
 - spec/support/fixtures.rb