spaceship 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02178127118d73630e027800cd0c2c759145444c
-  data.tar.gz: d74fd79faf660145dceacfe275b59db20f24067d
+  metadata.gz: c2eeb8fbd4efa37ca93d8d46cd37f89581a00b08
+  data.tar.gz: 40a38a219fb822a734860cf834b522288e9eb975
 SHA512:
-  metadata.gz: 53c9952a624da716a1777b4ec5cff8d4a80c166bf8f2e710f956a231adfc77b2f254025da34473c3fd48a4ffced5ab821412e20e6417be100c3970b28c51c9e1
-  data.tar.gz: 884cc41a088ed45f6e257bd5f9355685cd6c95c1962272d0595ce844047b4dc46e168db0df0b5c05180daf538242ff21e8daeac132155b31d3daf66020c47f94
+  metadata.gz: 3143acb445f65780d6188d9281bf2fc68ec1e3c831f486c27152a4129eebcbc3c39bbcf7141e6c2db0730fb9b07143e38db895c3767b2fce9fe7160e8332b9f4
+  data.tar.gz: a7a4738fa19e112b008119517423e14e933171e018c73e7e00064b4f2747def35ec6089b6a00f39a2134976bd26325b985779ecdb12f04f5fd7b892ff35b021b

data/README.md

@@ -23,10 +23,10 @@
 -------
 
 [![Twitter: @KauseFx](https://img.shields.io/badge/contact-@KrauseFx-blue.svg?style=flat)](https://twitter.com/KrauseFx)
-[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/KrauseFx/spaceship/blob/master/LICENSE)
-[![Coverage Status](https://coveralls.io/repos/KrauseFx/spaceship/badge.svg?branch=master&t=ldL8gg)](https://coveralls.io/r/KrauseFx/spaceship?branch=master)
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/fastlane/spaceship/blob/master/LICENSE)
+[![Coverage Status](https://coveralls.io/repos/fastlane/spaceship/badge.svg?branch=master&t=ldL8gg)](https://coveralls.io/r/fastlane/spaceship?branch=master)
 [![Gem](https://img.shields.io/gem/v/spaceship.svg?style=flat)](http://rubygems.org/gems/spaceship)
-[![Codeship Status for KrauseFx/spaceship](https://img.shields.io/codeship/96bb1040-c2b6-0132-4c5b-22f8b41c2618/master.svg)](https://codeship.com/projects/73801)
+[![Build Status](https://img.shields.io/travis/fastlane/spaceship/master.svg?style=flat)](https://travis-ci.org/fastlane/spaceship)
 
 
 Get in contact with the developers on Twitter: [@snatchev](https://twitter.com/snatchev/) and [@KrauseFx](https://twitter.com/KrauseFx)

data/lib/spaceship/base.rb

@@ -1,20 +1,50 @@
 module Spaceship
+  ##
+  # Spaceship::Base is the superclass for models in Apple Developer Portal.
+  # It's mainly responsible for mapping responses to objects.
+  #
+  # A class-level attribute `client` is used to maintain the which spaceship we
+  # are using to talk to ADP.
+  #
+  # Example of creating a new ADP model:
+  #
+  #   class Widget < Spaceship::Base
+  #     attr_accessor :id, :name, :foo_bar, :wiz_baz
+  #     attr_mapping({
+  #       'name' => :name,
+  #       'fooBar' => :foo_bar,
+  #       'wizBaz' => :wiz_baz
+  #     })
+  #   end
+  #
+  # When you want to instantiate a model pass in the parsed response: `Widget.new(widget_json)`
   class Base
     class << self
       attr_accessor :client
 
+      ##
+      # The client used to make requests.
+      # @return (Spaceship::Client) Defaults to the singleton `Spaceship.client`
       def client
         @client || Spaceship.client
       end
 
-      #set client and return self for chaining
+      ##
+      # Sets client and returns self for chaining.
+      # @return (Spaceship::Base)
       def set_client(client)
         self.client = client
         self
       end
 
       ##
-      # bang method since it changes the parameter in-place
+      # Remaps the attributes passed into the initializer to the model
+      # attributes using the map defined by `attr_map`.
+      #
+      # This method consumes the input parameter meaning attributes that were
+      # remapped are deleted.
+      #
+      # @return (Hash) the attribute mapping used by `remap_keys!`
       def remap_keys!(attrs)
         return if attr_mapping.nil?
 
@@ -23,6 +53,20 @@ module Spaceship
         end
       end
 
+      ##
+      # Defines the attribute mapping between the response from Apple and our model objects.
+      # Keys are to match keys in the response and the values are to match attributes on the model.
+      #
+      # Example of using `attr_mapping`
+      #
+      #   class Widget < Spaceship::Base
+      #     attr_accessor :id, :name, :foo_bar, :wiz_baz
+      #     attr_mapping({
+      #       'name' => :name,
+      #       'fooBar' => :foo_bar,
+      #       'wizBaz' => :wiz_baz
+      #     })
+      #   end
       def attr_mapping(attr_map = nil)
         if attr_map
           @attr_mapping = attr_map
@@ -61,6 +105,11 @@ module Spaceship
       end
     end
 
+    ##
+    # The initialize method accepts a parsed response from Apple and sets all
+    # attributes that are defined by `attr_mapping`
+    #
+    # Do not override `initialize` in your own models.
     def initialize(attrs = {})
       self.class.remap_keys!(attrs)
       attrs.each do |key, val|
@@ -69,6 +118,8 @@ module Spaceship
       @client = self.class.client
     end
 
+    ##
+    # @return (Spaceship::Client) The current spaceship client used by the model to make requests.
     def client
       @client
     end

data/lib/spaceship/client.rb

@@ -207,6 +207,19 @@ module Spaceship
       @current_team_id = team_id
     end
 
+    # @return (Hash) Fetches all information of the currently used team
+    def team_information
+      teams.find do |t|
+        t['teamId'] == team_id
+      end
+    end
+
+    # Is the current session from an Enterprise In House account?
+    def in_house?
+      return @in_house unless @in_house.nil?
+      @in_house = (team_information['type'] == 'In-House')
+    end
+
     #####################################################
     # @!group Apps
     #####################################################

data/lib/spaceship/version.rb

@@ -1,3 +1,3 @@
 module Spaceship
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spaceship
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Stefan Natchev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: credentials_manager