cocoapods-repo-sq 0.0.1.6

data/lib/pod/command/repo_sq/list.rb

@@ -0,0 +1,55 @@
+# coding: utf-8
+
+# This source file is part of the cocoapods-repo-sq plugin under the Apache 2.0
+# license:
+#
+#    Copyright 2018 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+# =============================================================================
+
+module Pod
+  class Command
+    class RepoSq < Command
+      # Subclass of {RepoSq}
+      # Provides support for the `pod repo-sq list` command, which lists the
+      # Square SDK repositories currently registered on the user's cocoapods
+      # local repositories store.
+      class List < RepoSq
+        self.summary = 'List configured Square SDK repositories'
+
+        self.description = <<-DESC
+          List all Square SDK repositories added to your local Cocoapod's sources registry.
+        DESC
+
+        # Lists all Square SDK repositories registered on the current user
+        # {CocoapodsRepoSq::RepositoryStore}.
+        def run
+          repositories = repository_store.list
+
+          repositories.each do |repository|
+            UI.title "Square SDK repository: #{repository.name}" do
+              UI.puts " - URL:  #{repository.url}"
+              UI.puts " - Path: #{repository.path}"
+            end
+          end
+          UI.puts "\n"
+
+          n = repositories.length
+          UI.puts "#{n} #{n != 1 ? 'repositories' : 'repository'}".green
+        end
+      end
+    end
+  end
+end

data/lib/pod/command/repo_sq/remove.rb

@@ -0,0 +1,61 @@
+# coding: utf-8
+#
+# This source file is part of the cocoapods-repo-sq plugin under the Apache 2.0
+# license:
+#
+#    Copyright 2018 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+# =============================================================================
+
+module Pod
+  class Command
+    class RepoSq < Command
+      # Subclass of {RepoSq}
+      # Provides support for the `pod repo-sq remove` command, which removes
+      # the targeted Square SDK repository from the user's cocoapods local
+      # repositories store.
+      class Remove < RepoSq
+        self.summary = 'Remove a Square SDK repository'
+
+        self.description = <<-DESC
+          Removes the Square SDK repository for your application `NAME`.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('NAME', true),
+        ]
+
+        def initialize(argv)
+          @name = argv.shift_argument
+          super
+        end
+
+        # Validates that the required argument `NAME` is present.
+        def validate!
+          super
+          help! '`NAME` is required.' unless @name
+        end
+
+        # Removes a Square SDK repository from the current user
+        # {CocoapodsRepoSq::RepositoryStore}.
+        def run
+          UI.section("Removing Square SDK repository `#{@name}`") do
+            repository_store.remove(@name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pod/command/repo_sq/update.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+
+# This source file is part of the cocoapods-repo-sq plugin under the Apache 2.0
+# license:
+#
+#    Copyright 2018 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+# =============================================================================
+
+module Pod
+  class Command
+    class RepoSq < Command
+      # Subclass of {RepoSq}
+      # Provides support for the `pod repo-sq remove` command, which updates
+      # the targeted Square SDK repository on the user's cocoapods local
+      # repositories store.
+      class Update < RepoSq
+        self.summary = 'Update Square SDK repository specs'
+
+        self.description = <<-DESC
+          Updates Square SDK repository for your application `NAME`.
+        DESC
+
+        self.arguments = [
+          CLAide::Argument.new('NAME', true),
+        ]
+
+        def initialize(argv)
+          @name = argv.shift_argument
+          super
+        end
+
+        # Validates that the required argument `NAME` is present.
+        def validate!
+          super
+          help! '`NAME` is required.' unless @name
+        end
+
+        # Updates the podspecs of Square SDK repository on the current user
+        # {CocoapodsRepoSq::RepositoryStore}.
+        def run
+          UI.section("Updating Square SDK repository `#{@name}`") do
+            repository = repository_store.get(@name)
+            repository.update_specs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pod/command/repo_sq.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+#
+# Copyright 2018 Square Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'pod/command/repo_sq/add'
+require 'pod/command/repo_sq/list'
+require 'pod/command/repo_sq/remove'
+require 'pod/command/repo_sq/update'
+
+module Pod
+  class Command
+    # Subclass of Pod::Command to provide `pod repo-sq` command to manage Square SDK repositories
+    #
+    class RepoSq < Command
+      self.abstract_command = true
+
+      self.summary = 'Manage Square SDK repositories'
+      self.default_subcommand = 'list'
+
+      private
+      def repository_store
+        @repository_store ||= CocoapodsRepoSq::RepositoryStore.default
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,80 @@
+# coding: utf-8
+#
+# Copyright 2018 Square Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+require 'simplecov'
+SimpleCov.start
+
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'cocoapods'
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'cocoapods_plugin'
+
+TEST_REPOS_PATH = File.expand_path(File.join(File.dirname(__FILE__), 'test-repos'))
+CocoapodsRepoSq::RepositoryStore.class_eval do
+  @default = new(TEST_REPOS_PATH)
+end
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = []
+    @warnings = []
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+
+      def reset
+        self.title_level = 0
+        self.output.clear
+        self.warnings.clear
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#
+

data/spec/test-repos/repo-1/.settings.yml

@@ -0,0 +1,4 @@
+:name: repo-1
+:username: app-1
+:password: pass-1
+:url: http://app-1.com/

data/spec/test-repos/repo-2/.settings.yml

@@ -0,0 +1,4 @@
+:name: repo-2
+:username: app-2
+:password: pass-2
+:url: http://app-2.com/

data/spec/unit/cocoapods_plugin_spec.rb

@@ -0,0 +1,108 @@
+# coding: utf-8
+
+# This source file is part of the cocoapods-repo-sq plugin under the Apache 2.0
+# license:
+#
+#    Copyright 2018 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+# =============================================================================
+
+describe 'Plugin Hook' do
+  before do
+    CocoapodsRepoSq::Repository.current = nil
+  end
+
+  describe 'registration' do
+    it 'should register plugin as a :source_provider' do
+      Pod::HooksManager.registrations.should.include(:source_provider)
+      Pod::HooksManager.registrations[:source_provider][0].plugin_name.should.equal('cocoapods-repo-sq')
+    end
+  end
+
+  describe 'installation' do
+    before { @block = Pod::HooksManager.registrations[:source_provider][0].block }
+
+    it 'should fail when `repository` is not provided' do
+      lambda { @block.call(nil, {}) }.
+        should.raise(Pod::Informative).
+        message.should.match /repository is needed for `cocoapods-repo-sq`/
+    end
+
+    it 'should fail when a repository does not exist for `repository`' do
+      lambda { @block.call(nil, { 'repository' => 'non-existant' }) }.
+        should.raise(Pod::Informative).
+        message.should.match /Square SDK repository `non-existant` does not exist/
+    end
+
+    it 'should set the current repository and configure a CocoapodsRepoSq::Source' do
+      context = mock('context')
+      context.expects(:add_source)
+
+      CocoapodsRepoSq::Repository.current.should.be.nil?
+      @block.call(context, { 'repository' => 'repo-1' })
+      CocoapodsRepoSq::Repository.current.should.not.be.nil?
+    end
+
+    it 'should update repository specs when running `pod update`' do
+      repository_name = 'repo-1'
+      repository = mock('repository')
+      repository.expects(:update_specs)
+      repository.expects(:path).returns('/path')
+      store = CocoapodsRepoSq::RepositoryStore.default
+      store.expects(:exists?).with(repository_name).returns(true)
+      store.expects(:get).with(repository_name).returns(repository)
+      context = mock('context')
+      context.expects(:add_source)
+      ARGV = ['update']
+
+      CocoapodsRepoSq::Repository.current.should.be.nil?
+      @block.call(context, { 'repository' => repository_name })
+      CocoapodsRepoSq::Repository.current.should.not.be.nil?
+    end
+
+    it 'should update repository specs when running `pod install --repo-update`' do
+      repository_name = 'repo-1'
+      repository = mock('repository')
+      repository.expects(:update_specs)
+      repository.expects(:path).returns('/path')
+      store = CocoapodsRepoSq::RepositoryStore.default
+      store.expects(:exists?).with(repository_name).returns(true)
+      store.expects(:get).with(repository_name).returns(repository)
+      context = mock('context')
+      context.expects(:add_source)
+      ARGV = ['install', '--repo-update']
+
+      CocoapodsRepoSq::Repository.current.should.be.nil?
+      @block.call(context, { 'repository' => repository_name })
+      CocoapodsRepoSq::Repository.current.should.not.be.nil?
+    end
+
+    it 'should not update repository specs when running `pod update --no-repo-update`' do
+      repository_name = 'repo-1'
+      repository = mock('repository')
+      repository.expects(:path).returns('/path')
+      store = CocoapodsRepoSq::RepositoryStore.default
+      store.expects(:exists?).with(repository_name).returns(true)
+      store.expects(:get).with(repository_name).returns(repository)
+      context = mock('context')
+      context.expects(:add_source)
+      ARGV = ['--no-repo-update', '--verbose', 'update']
+
+      CocoapodsRepoSq::Repository.current.should.be.nil?
+      @block.call(context, { 'repository' => repository_name })
+      CocoapodsRepoSq::Repository.current.should.not.be.nil?
+    end
+  end
+end

data/spec/unit/cocoapods_repo_sq/downloader_spec.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+# This source file is part of the cocoapods-repo-sq plugin under the Apache 2.0
+# license:
+#
+#    Copyright 2018 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+# =============================================================================
+
+module CocoapodsRepoSq
+  describe Downloader do
+    before do
+      store = RepositoryStore.default
+      @repository = store.get('repo-1')
+      Repository.current = store.get('repo-2')
+    end
+
+    it 'registers Square in the list of downloaders' do
+      Pod::Downloader.downloader_class_by_key.should.include :square
+      Pod::Downloader.downloader_class_by_key[:square].should.equal Downloader
+    end
+
+    it 'should download a file from the provided repository' do
+      dest_path = File.join(File.dirname(__FILE__))
+      downloader = Downloader.new(dest_path, "specs-resource.zip", :repository => @repository)
+
+      output_file = Pathname(File.join(dest_path, 'file.zip'))
+      downloader.expects(:curl!).with('-u', "app-1:pass-1", '-f', '-L', '-o', output_file, 'http://app-1.com/specs-resource.zip', '--create-dirs', '--netrc-optional')
+      downloader.expects(:unzip!).with(output_file, '-d', Pathname(dest_path))
+
+      downloader.download
+    end
+
+    it 'should download a file from the current repository when none if provided' do
+      dest_path = File.join(File.dirname(__FILE__))
+      downloader = Downloader.new(dest_path, "specs-resource.zip", {})
+
+      output_file = Pathname(File.join(dest_path, 'file.zip'))
+      downloader.expects(:curl!).with('-u', "app-2:pass-2", '-f', '-L', '-o', output_file, 'http://app-2.com/specs-resource.zip', '--create-dirs', '--netrc-optional')
+      downloader.expects(:unzip!).with(output_file, '-d', Pathname(dest_path))
+
+      downloader.download
+    end
+  end
+end

data/spec/unit/cocoapods_repo_sq/repository_spec.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+# This source file is part of the cocoapods-repo-sq plugin under the Apache 2.0
+# license:
+#
+#    Copyright 2018 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+# =============================================================================
+
+module CocoapodsRepoSq
+  describe Repository do
+    before do
+      @name = 'repo-1'
+      @username = 'app-1'
+      @password = 'pass-1'
+      @url = 'http://app-1.com'
+      @path = '/path/to/repo'
+      @repository = Repository.new(@name, @username, @password, @url, @path)
+    end
+
+    it 'should initialize the repository with provided settings' do
+      @repository.name.should.equal(@name)
+      @repository.username.should.equal(@username)
+      @repository.password.should.equal(@password)
+      @repository.url.should.equal(@url)
+      @repository.path.should.equal(@path)
+    end
+
+    it 'should download specifications when calling update_specs' do
+      downloader = mock('downloader')
+      downloader.expects(:download)
+
+      new_specs_path = File.join(@path, 'Specs.new')
+      specs_path = File.join(@path, 'Specs')
+      CocoapodsRepoSq::Downloader.expects(:new).with(new_specs_path, "specs.zip", :repository => @repository).returns(downloader)
+
+      FileUtils.expects(:rm_rf).with(new_specs_path)
+      FileUtils.expects(:rm).with(File.join(new_specs_path, "file.zip"))
+      FileUtils.expects(:rm_rf).with(specs_path)
+      FileUtils.expects(:mv).with(new_specs_path, specs_path)
+
+      @repository.update_specs
+    end
+  end
+end

data/spec/unit/cocoapods_repo_sq/repository_store_spec.rb

@@ -0,0 +1,124 @@
+# coding: utf-8
+
+# This source file is part of the cocoapods-repo-sq plugin under the Apache 2.0
+# license:
+#
+#    Copyright 2018 Square Inc.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+# =============================================================================
+
+module CocoapodsRepoSq
+  describe RepositoryStore do
+    describe 'initialize' do
+      it 'should use Cocoapods home directory when nothing is passed' do
+        expected_path = File.join(Pod::Config.instance.home_dir, 'repo-sq')
+        store = RepositoryStore.new
+
+        store.instance_eval('@path').should.equal expected_path
+        Dir.exists?(expected_path).should.be.true?
+      end
+
+      it 'should allow customizing the base repository path' do
+        expected_path = File.join(File.dirname(__FILE__), 'repo-sq')
+        store = RepositoryStore.new(expected_path)
+
+        store.instance_eval('@path').should.equal expected_path
+        Dir.exists?(expected_path).should.be.true?
+      end
+    end
+
+    describe 'instance methods' do
+      before do
+        @store = CocoapodsRepoSq::RepositoryStore.default
+        @base_path = @store.instance_eval('@path')
+      end
+
+      describe 'exists?' do
+        it 'checks for the existence of the settings file' do
+          name = 'repo-1'
+          File.expects(:exists?).with(File.join(@base_path, name, '.settings.yml')).returns(true)
+          @store.exists?(name).should.be.true?
+        end
+      end
+
+      describe 'list' do
+        it 'lists all existing repositories' do
+          repositories = @store.list
+          repositories.count.should.equal 2
+          repositories.each{ |r| r.should.be.instance_of Repository }
+          repositories.map(&:name).sort.should.equal ['repo-1', 'repo-2']
+        end
+      end
+
+      describe 'get' do
+        it 'returns nil when repository does not exist' do
+          repository = @store.get('repo-3')
+          repository.should.be.nil?
+        end
+
+        it 'returns a valid repository object when repository exists' do
+          repository = @store.get('repo-1')
+          repository.should.be.instance_of Repository
+          repository.name.should.equal 'repo-1'
+          repository.username.should.equal 'app-1'
+          repository.password.should.equal 'pass-1'
+          repository.url.should.equal 'http://app-1.com/'
+        end
+      end
+
+      describe 'register' do
+        it 'raises an exception when the repository already exists' do
+          lambda{ @store.register('repo-1', 'app-1', 'pass-1', 'url-1') }.
+            should.raise(Pod::Informative).
+            message.should.match /Square SDK repository `repo-1` is already configured/
+        end
+
+        it 'cleans repository path if it fails to register' do
+          error = StandardError.new('error')
+          @store.expects(:store_settings!).raises(error)
+          @store.expects(:remove).with('repo-4')
+
+          lambda{ @store.register('repo-4', 'app-4', 'pass-4', 'url-4') }.
+            should.raise(StandardError)
+        end
+
+        it 'creates settings file and returns repository when successfully adding it' do
+          repository = @store.register('repo-4', 'app-4', 'pass-4', 'url-4')
+          repository.name.should.equal 'repo-4'
+          repository.username.should.equal 'app-4'
+          repository.password.should.equal 'pass-4'
+          repository.url.should.equal 'url-4'
+          File.exists?(File.join(@base_path, 'repo-4', '.settings.yml')).should.be.true?
+          @store.remove('repo-4').should.be.true?
+        end
+      end
+
+      describe 'remove' do
+        it 'returns false when no repository is removed' do
+          @store.remove('repo-7').should.be.false?
+          Dir.exists?(File.join(@base_path, 'repo-3')).should.be.false?
+        end
+
+        it 'creates settings file and returns repository when successfully adding it' do
+          @store.register('repo-4', 'app-4', 'pass-4', 'url-4')
+          File.exists?(File.join(@base_path, 'repo-4', '.settings.yml')).should.be.true?
+
+          @store.remove('repo-4').should.be.true?
+          Dir.exists?(File.join(@base_path, 'repo-4')).should.be.false?
+        end
+      end
+    end
+  end
+end