hockeyhelper 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c327aeb19606a5b2b3dee8d9ee6499ea8d9961c
-  data.tar.gz: fdc4a74ef9f44cec7449921b90c9e1df9dfb2c1f
+  metadata.gz: 361f2c3a9a76cf49107f730ecef7116e49f013df
+  data.tar.gz: 0421c010c61dad94c49a94dc2c292d0c1fb6319a
 SHA512:
-  metadata.gz: d550230b9d93b87f964641ca8d7efb23ba63d2b807df87c0599f004cc46abf6691c8955e5bfde4e4e8d928c1a324b3e8dca391474a02742261c453922d605196
-  data.tar.gz: 6ec09c80f4df5c2ba6870f21d11e58a8b7a537d82e67337aada0d196b25bcbf582a9fde0ca5c080dc4ef22fa2b3a9f9e67b167ebf8545aa5532ab3dda5ef07ff
+  metadata.gz: ed29a07b77a17dbf91d6766a570d2115802250a4ae0093bd120f9c1637aad53b57ec0b2fdb786fff8bf60a443adba1ab0f2e0635f984619cb6cae00437530288
+  data.tar.gz: e170b47aed77cac749c202b8b0f1aa095c39a1171e11f49b48c871b8d33c271bd38bdeedeff98cc947ed5a4b90547d812dcbb5c63232978be2fc9bbaf1bc8725

data/Gemfile

@@ -2,7 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hockeyhelper.gemspec
 gemspec
-
-group :test do
-  gem 'rspec'
-end

data/README.md

@@ -1,8 +1,9 @@
-# Hockey
+# hockeyhelper gem
 
-Helper gem for HokceyApp API
+Helper gem for HokceyApp API.
 
 [![Build Status](https://travis-ci.org/yagihiro/hockey.svg?branch=master)](https://travis-ci.org/yagihiro/hockey)
+[![Gem Version](https://badge.fury.io/rb/hockeyhelper.svg)](http://badge.fury.io/rb/hockeyhelper)
 
 ## Installation
 
@@ -20,7 +21,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+create a new app and an invite user
+
+    require 'hockeyhelper'
+    client = Hockey::Client.new 'yourapitoken'
+    app = client.new_app(title: appname, bundle_identifier: bundleid, platform: platform)
+    user = app.invite_user(email: email)
+
+list all apps with paging
+
+    require 'hockeyhelper'
+    client = Hockey::Client.new 'yourapitoken'
+    apps = client.apps(page: 1)
+
+list all versions for an app
+
+    require 'hockeyhelper'
+    client = Hockey::Client.new 'yourapitoken'
+    versions = client.apps(page: 1)[0].versions
+
+list all users for an app
+
+    require 'hockeyhelper'
+    client = Hockey::Client.new 'yourapitoken'
+    users = client.apps(page: 1)[0].users
+
+remove a user from an app
+
+    require 'hockeyhelper'
+    client = Hockey::Client.new 'yourapitoken'
+    client.apps(page: 1)[0].remove_user 'email@xxx.xx'
+
+list all teams with paging
+
+    require 'hockeyhelper'
+    client = Hockey::Client.new 'yourapitoken'
+    teams = client.teams(page: 1)
 
 ## Contributing
 

data/Rakefile

@@ -1,7 +1,10 @@
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+task :default => :test
 
-task :test => :spec
-task :default => :spec
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['spec/*_spec.rb']
+  t.warning = true
+end

data/hockey.gemspec

@@ -21,5 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "yard"
   spec.add_dependency "faraday"
 end

data/lib/hockeyhelper/app.rb

@@ -39,15 +39,8 @@ module Hockey
     end
     alias_method :to_s, :inspect
 
-    def remove_user(email:nil)
-      users()
-      user = @users.find {|u| u.email == email }
-
-      if user
-        @net.delete "/api/2/apps/#{@public_identifier}/app_users/#{user.id}"
-      end
-    end
-
+    # List all users of an app on HockeyApp.
+    # return an Array of User objects.
     def users
       return @users if @users
 
@@ -61,6 +54,28 @@ module Hockey
       @users
     end
 
+    # Invite a user to an app.
+    # return a User object.
+    def invite_user(email:email)
+      obj = @net.post_object "/api/2/apps/#{@public_identifier}/app_users", {:email=>email, :role=>1}
+
+      user = User.create_from(obj, @net)
+
+      user
+    end
+
+    # Remove a user from an app on HockeyApp.
+    def remove_user(email:nil)
+      users()
+      user = @users.find {|u| u.email == email }
+
+      if user
+        @net.delete "/api/2/apps/#{@public_identifier}/app_users/#{user.id}"
+      end
+    end
+
+    # List all versions of an app. The endpoint returns all versions for developer and members, but only released versions for testers.
+    # return an Array of Version objects.
     def versions
       return @versions if @versions
 
@@ -74,12 +89,22 @@ module Hockey
       @versions
     end
 
-    def invite_user(email:email)
-      obj = @net.post_object "/api/2/apps/#{@public_identifier}/app_users", {:email=>email, :role=>1}
-
-      user = User.create_from(obj, @net)
+    # List all crash groups for an app.
+    # return an Array of CrashReason objects.
+    #
+    # +sort+ parameter:
+    #   :date, :class, :number_of_crashes, :last_crash_at
+    # +order+ parameter:
+    #   :asc, :desc
+    def crash_reasons(page: 1, per: 25, symbolicated: true, sort: :date, order: :asc)
+      obj = @net.get_object "/api/2/apps/#{@public_identifier}/crash_reasons"
+
+      cr = []
+      obj['crash_reasons'].each do |hashobj|
+        cr << CrashReason.create_from(hashobj, @net)
+      end
 
-      user
+      cr
     end
 
   end

data/lib/hockeyhelper/client.rb

@@ -1,5 +1,6 @@
 require_relative 'app'
 require_relative 'networking'
+require_relative 'paging_array'
 
 module Hockey
 
@@ -7,52 +8,54 @@ module Hockey
   class Client
 
     #
-    def initialize(token, debug:false)
-      @net = Networking.new token, debug:debug
-      @apps = nil
-      @teams = nil
+    def initialize(token, debug: false, network: nil)
+      @net = network || Networking.new(token, debug:debug)
+      @cached_apps = nil
     end
 
-    # return Array of App objects
-    def apps
-      return @apps if @apps
-
-      obj = @net.get_object '/api/2/apps'
-
-      @apps = []
-      obj['apps'].each do |hashobj|
-        @apps << App.create_from(hashobj, @net)
+    # List all apps for the logged user, including owned apps, developer apps, member apps, and tester apps on HockeyApp.
+    #
+    # @return [Array<App>] an array of {App} objects.
+    # @param page [Fixnum] optional, used for pagination
+    def apps(page: 1)
+      @cached_apps ||= []
+
+      if @cached_apps.empty?
+        obj = @net.get_object '/api/2/apps'
+        obj['apps'].each do |hashobj|
+          @cached_apps << App.create_from(hashobj, @net)
+        end
       end
 
-      @apps
-    end
-
-    # return Array of Team objects
-    def teams
-      return @teams if @teams
-
-      @teams = []
-      page = 1
+      apps = PagingArray.new
+      apps.replace(@cached_apps[(page - 1) * apps.per_page, apps.per_page])
+      apps.update_page_with(page, @cached_apps.size)
 
-      while true
-        obj = @net.get_object('/api/2/teams') do |req|
-          req.params[:page] = page
-        end
-        obj['teams'].each do |hashobj|
-          @teams << Team.create_from(hashobj, @net)
-        end
+      apps
+    end
 
-        total = obj['total_pages'].to_i
-        break unless page < total
+    # List all teams for an account.
+    #
+    # @return [Hockey::PagingArray<Team>] an array of {Team} objects
+    # @param page [Fixnum] optional, used for pagination
+    def teams(page: 1)
+      teams = PagingArray.new
 
-        page = page + 1
+      obj = @net.get_object('/api/2/teams') do |req|
+        req.params[:page] = page
+      end
+      obj['teams'].each do |hashobj|
+        teams << Team.create_from(hashobj, @net)
       end
 
-      @teams
+      teams.update_page(obj)
+
+      teams
     end
 
-    # create new app on HockeyApp
-    def new_app(title:title, bundle_identifier:bundle_identifier, platform: 'iOS')
+    # Create a new app without uploading a file on HockeyApp.
+    # return an App object.
+    def new_app(title: '', bundle_identifier: '', platform: 'iOS')
       obj = @net.post_object '/api/2/apps/new', {:title=>title, :bundle_identifier=>bundle_identifier, :platform=>platform, :release_type=>0}
 
       app = App.create_from(obj, @net)

data/lib/hockeyhelper/crash_reason.rb

@@ -0,0 +1,58 @@
+module Hockey
+
+  # CrashReason on HockeyApp
+  class CrashReason
+
+    attr_reader :id
+    attr_reader :app_id
+    attr_reader :app_version_id
+    attr_reader :number_of_crashes
+    attr_reader :created_at
+    attr_reader :updated_at
+    attr_reader :last_crash_at
+    attr_reader :bundle_short_version
+    attr_reader :bundle_version
+    attr_reader :status
+    attr_reader :fixed
+    attr_reader :file
+    attr_reader :crash_class
+    attr_reader :crash_method
+    attr_reader :line
+    attr_reader :reason
+    attr_reader :original_hash
+
+    attr :net
+
+    def self.create_from(hashobj, networking)
+      self.new hashobj, networking
+    end
+
+    def initialize(hashobj, networking)
+      @id = hashobj['id']
+      @app_id = hashobj['app_id']
+      @app_version_id = hashobj['app_version_id']
+      @number_of_crashes = hashobj['number_of_crashes']
+      @created_at = hashobj['created_at']
+      @updated_at = hashobj['updated_at']
+      @last_crash_at = hashobj['last_crash_at']
+      @bundle_short_version = hashobj['bundle_short_version']
+      @bundle_version = hashobj['bundle_version']
+      @status = hashobj['status']
+      @fixed = hashobj['fixed']
+      @file = hashobj['file']
+      @crash_class = hashobj['class']
+      @crash_method = hashobj['method']
+      @line = hashobj['line']
+      @reason = hashobj['reason']
+      @original_hash = hashobj
+      @net = networking
+    end
+
+    def inspect
+      "#<#{self.class}:#{'0x%08x' % self.hash} #{@id}, #{@file}, #{@crash_class}, #{@crash_method}, #{@line}>"
+    end
+    alias_method :to_s, :inspect
+
+  end
+
+end

data/lib/hockeyhelper/networking.rb

@@ -7,11 +7,11 @@ module Hockey
   class NullLogger < Logger
     def initialize *args
     end
-    def debug; end
-    def info; end
-    def warn; end
-    def error; end
-    def fatal; end
+    def debug(*args); end
+    def info(*args); end
+    def warn(*args); end
+    def error(*args); end
+    def fatal(*args); end
   end
 
   # Networking Core Lib
@@ -19,7 +19,9 @@ module Hockey
 
     attr :l
 
-    def initialize(token, debug:false)
+    def initialize(token, debug: false)
+      raise(ArgumentError, 'token must be an instance of String') unless token.kind_of?(String)
+
       @client = Faraday.new(:url => 'https://rink.hockeyapp.net')
       @token = token
       @l = if debug

data/lib/hockeyhelper/paging_array.rb

@@ -0,0 +1,41 @@
+module Hockey
+
+  class PagingArray < Array
+    attr_reader :current_page
+    attr_reader :per_page         # = 25
+    attr_reader :total_entries
+    attr_reader :total_pages
+
+    def initialize
+      super
+      @per_page = 25
+    end
+
+    def update_page(hashobj)
+      @current_page  = hashobj['current_page'].to_i
+      @total_entries = hashobj['total_entries'].to_i
+      @total_pages   = hashobj['total_pages'].to_i
+
+      self
+    end
+
+    def update_page_with(page, size)
+      @current_page = page
+      @total_entries = size
+      @total_pages = (size / @per_page) + 1
+
+      self
+    end
+
+  end
+
+  class OrderedPagingArray < PagingArray
+    attr :order_type
+  end
+
+  class ClashesPagingArray < OrderedPagingArray
+    attr :symbolicated
+    attr :sort_type
+  end
+
+end

data/lib/hockeyhelper/version.rb

@@ -1,6 +1,6 @@
 module Hockey
 
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
   # Version on HockeyApp
   class Version

data/lib/hockeyhelper.rb

@@ -1,6 +1,8 @@
 require 'hockeyhelper/app'
 require 'hockeyhelper/client'
+require 'hockeyhelper/crash_reason'
 require 'hockeyhelper/networking'
+require 'hockeyhelper/paging_array'
 require 'hockeyhelper/team'
 require 'hockeyhelper/user'
 require 'hockeyhelper/version'

data/spec/app_spec.rb

@@ -1,5 +0,0 @@
-require_relative '../lib/hockeyhelper/app'
-
-RSpec.describe Hockey::App do
-
-end

data/spec/client_spec.rb

@@ -0,0 +1,158 @@
+require 'minitest/autorun'
+require 'hockeyhelper'
+
+describe Hockey::Client do
+
+  describe 'initialize' do
+
+    it 'when no argument' do
+      proc { Hockey::Client.new }.must_raise(ArgumentError)
+    end
+
+    it 'when specified an argument' do
+      proc { Hockey::Client.new(1) }.must_raise(ArgumentError)
+
+      client = Hockey::Client.new ''
+      client.must_be_instance_of Hockey::Client
+    end
+
+  end
+
+  describe 'apps' do
+
+    before do
+      @page1 =<<_EOS_
+{
+    "apps": [
+        {
+            "title": "HockeyTest",
+            "bundle_identifier": "de.codenauts.hockeytest.beta",
+            "public_identifier": "1234567890abcdef1234567890abcdef",
+            "device_family": "iPhone/iPod",
+            "minimum_os_version": "4.0",
+            "release_type": 0,
+            "status": 2,
+            "platform": "iOS"
+        },
+        {
+            "title": "HockeyTest",
+            "bundle_identifier": "de.codenauts.hockeytest",
+            "public_identifier": "34567890abcdef1234567890abcdef12",
+            "release_type": 1,
+            "platform": "iOS"
+        }
+    ],
+    "status": "success"
+}
+_EOS_
+    end
+
+    it 'when succeeded' do
+      net_mock = Minitest::Mock.new
+      client = Hockey::Client.new 'token', network: net_mock
+
+      net_mock.expect(:get_object, JSON.parse(@page1), ['/api/2/apps'])
+      apps = client.apps(page: 1)
+      apps.must_be_kind_of Hockey::PagingArray
+      apps.size.must_equal 2
+      apps.each do |obj|
+        obj.must_be_instance_of Hockey::App
+      end
+      apps[0].bundle_identifier.must_equal 'de.codenauts.hockeytest.beta'
+      apps[1].bundle_identifier.must_equal 'de.codenauts.hockeytest'
+      net_mock.verify
+    end
+
+  end
+
+  describe 'teams' do
+
+    before do
+      @page1 =<<_EOS_
+{
+    "teams": [
+        {
+            "id": 23,
+            "name": "Bit Stadium GmbH Owners"
+        },
+        {
+            "id": 42,
+            "name": "External Testers"
+        }
+    ],
+    "status": "success",
+    "current_page": 1,
+    "per_page": 25,
+    "total_entries": 3,
+    "total_pages": 2
+}
+_EOS_
+      @page2 =<<_EOS_
+{
+    "teams": [
+        {
+            "id": 50,
+            "name": "Bit Stadium GmbH Owners"
+        }
+    ],
+    "status": "success",
+    "current_page": 2,
+    "per_page": 25,
+    "total_entries": 3,
+    "total_pages": 2
+}
+_EOS_
+    end
+
+    it 'when succeeded' do
+      net_mock = Minitest::Mock.new
+      client = Hockey::Client.new 'token', network: net_mock
+
+      net_mock.expect(:get_object, JSON.parse(@page1), ['/api/2/teams'])
+      teams = client.teams
+      teams.must_be_kind_of Hockey::PagingArray
+      teams.size.must_equal 2
+      teams.each do |obj|
+        obj.must_be_instance_of Hockey::Team
+      end
+      teams[0].id.must_equal 23
+      teams[1].id.must_equal 42
+      net_mock.verify
+    end
+
+    it 'when success w/ paging' do
+      net_mock = Minitest::Mock.new
+      client = Hockey::Client.new 'token', network: net_mock
+
+      net_mock.expect(:get_object, JSON.parse(@page1), ['/api/2/teams'])
+      teams = client.teams(page: 1)
+      teams.must_be_kind_of Hockey::PagingArray
+      teams.size.must_equal 2
+      teams.each do |obj|
+        obj.must_be_instance_of Hockey::Team
+      end
+      teams[0].id.must_equal 23
+      teams[1].id.must_equal 42
+      teams.current_page.must_equal 1
+      teams.total_entries.must_equal 3
+      teams.total_pages.must_equal 2
+
+      net_mock.expect(:get_object, JSON.parse(@page2), ['/api/2/teams'])
+      teams = client.teams(page: 2)
+      teams.must_be_kind_of Hockey::PagingArray
+      teams.size.must_equal 1
+      teams.each do |obj|
+        obj.must_be_instance_of Hockey::Team
+      end
+      teams[0].id.must_equal 50
+      teams.current_page.must_equal 2
+      teams.total_entries.must_equal 3
+      teams.total_pages.must_equal 2
+
+      net_mock.verify
+    end
+
+  end
+
+end
+

metadata

@@ -1,55 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: hockeyhelper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Hiroki Yagita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !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: minitest
+  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: yard
+  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: faraday
   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'
 description: 
@@ -59,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -69,11 +97,14 @@ files:
 - lib/hockeyhelper.rb
 - lib/hockeyhelper/app.rb
 - lib/hockeyhelper/client.rb
+- lib/hockeyhelper/crash_reason.rb
 - lib/hockeyhelper/networking.rb
+- lib/hockeyhelper/paging_array.rb
 - lib/hockeyhelper/team.rb
 - lib/hockeyhelper/user.rb
 - lib/hockeyhelper/version.rb
 - spec/app_spec.rb
+- spec/client_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -84,12 +115,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -100,3 +131,5 @@ specification_version: 4
 summary: Helper gem for HokceyApp API
 test_files:
 - spec/app_spec.rb
+- spec/client_spec.rb
+has_rdoc: