deliver 0.0.1 → 0.1.0

data/spec/deliverer_spec.rb

@@ -0,0 +1,48 @@
+describe Deliver do
+  describe Deliver::Deliverer do
+    describe "#initialize with hash" do
+      it "raises an exception when some information is missing" do
+        expect {
+          @meta = Deliver::Deliverer.new(nil, hash: {})
+        }.to raise_exception("You have to pass a valid app identifier using the Deliver file. (e.g. 'app_identifier \"net.sunapps.app\"')".red)
+      end
+
+      it "works with valid data" do
+        Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/download_valid_apple_id.txt")
+        Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt") # metadata
+        Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt") # ipa file
+
+        version = '1.0'
+        identifier = 'at.felixkrause.iTanky'
+        ipa = "spec/fixtures/ipas/Example1.ipa"
+
+        @meta = Deliver::Deliverer.new(nil, hash: {
+          app_identifier: identifier,
+          version: version,
+          ipa: ipa
+        })
+
+        expect(@meta.deliver_process.deploy_information[:version]).to eq(version)
+        expect(@meta.deliver_process.deploy_information[:app_identifier]).to eq(identifier)
+        expect(@meta.deliver_process.deploy_information[:ipa]).to eq(ipa)
+      end
+    end
+
+    describe "#set_new_value" do
+      it "raises an exception when invalid key is used" do
+        expect {
+          Deliver::Deliverer.new(nil, hash: { app_identifier: 'net.sunapps.54', invalid_key: '1' })
+        }.to raise_error("Invalid key 'invalid_key', must be contained in Deliverer::ValKey.".red)
+      end
+
+      it "works when the same value is set twice" do
+        Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/download_valid_apple_id.txt")
+        Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+
+        del = Deliver::Deliverer.new(nil, hash: { app_identifier: 'net.sunapps.54', version: '1.0', apple_id: 878567776 })
+        del.set_new_value(:version, '2.0')
+        expect(del.deliver_process.deploy_information[:version]).to eq("2.0")
+      end
+    end
+  end
+end

data/spec/deliverfile_creator_spec.rb

@@ -0,0 +1,73 @@
+describe Deliver do
+  describe Deliver::DeliverfileCreator do
+    before do
+      @path = "/tmp"
+      @deliver_path = [@path, 'Deliverfile'].join("/")
+      
+      FileUtils.rm(@deliver_path) rescue nil
+    end
+
+    it "can create an example Deliverfile" do
+      Deliver::DeliverfileCreator.create_example_deliver_file(@deliver_path, 'deliver')
+      expect(File.read(@deliver_path)).to include("Dynamic generation of the ipa file")
+
+      default = File.read("./lib/assets/DeliverfileExample")
+      default.gsub!("[[APP_NAME]]", "deliver") # default name
+      expect(File.read(@deliver_path)).to eq(default)
+    end
+
+    it "raises an error if Deliverfile already exists" do
+      Deliver::DeliverfileCreator.create_example_deliver_file(@deliver_path, 'deliver')
+      expect {
+        Deliver::DeliverfileCreator.create(@path)
+      }.to raise_error("Deliverfile already exists at path '/tmp/Deliverfile'. Run 'deliver' to use Deliver.".red)
+    end
+
+    it "Can create a Deliverfile based on an existing app" do
+      identifier = 'net.sunapps.54'
+      apple_id = 284882215
+
+      deliver_path = "/tmp/deliver/"
+      FileUtils.rm_rf(deliver_path) rescue nil
+      FileUtils.rm_rf("/tmp/#{apple_id}.itmsp") rescue nil
+
+
+      
+
+      Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/download_valid_apple_id.txt")
+
+      folder = "/tmp/#{apple_id}.itmsp"
+      system("cp -R './spec/fixtures/example1.itmsp/' '#{folder}'")
+
+      project_name = "somethingFancy"
+      Deliver::DeliverfileCreator.create_based_on_identifier(@path, identifier, project_name)
+
+      
+      
+      # Check if all the files were correctly created at /tmp
+
+      # Check metadata.json
+      metadata = JSON.parse(File.read("#{deliver_path}/metadata.json"))
+      expect(metadata['en-US']['title']).to eq('Default English Title')
+      expect(metadata['de-DE']['title']).to eq('Example App Title')
+      expect(metadata['de-DE']['description']).to include('3D GPS Birdiebuch')
+      expect(metadata['de-DE']['version_whats_new']).to include('- Changelog Line 1')
+      expect(metadata['de-DE']['software_url']).to eq('http://sunapps.net')
+      expect(metadata['de-DE']['support_url']).to eq('http://www.sunapps.net/')
+      expect(metadata['de-DE']['keywords']).to eq(%w|personal sunapps sun sunapps felix krause|)
+
+      # Check Deliverfile
+      correct = File.read("./lib/assets/DeliverfileDefault")
+      correct.gsub!("[[APP_IDENTIFIER]]", 'net.sunapps.54')
+      correct.gsub!("[[APP_NAME]]", project_name)
+      expect(File.read("/tmp/Deliverfile")).to eq(correct)
+
+      expect(File.directory?([deliver_path, "screenshots"].join("/"))).to eq(true)
+      expect(File.directory?([deliver_path, "screenshots", "de-DE"].join("/"))).to eq(true)
+      expect(File.directory?([deliver_path, "screenshots", "en-US"].join("/"))).to eq(true)
+      expect(File.directory?([deliver_path, "screenshots", "en-AU"].join("/"))).to eq(false)
+
+      expect(File.read("/tmp/deliver/screenshots/README.txt")).to eq(File.read("./lib/assets/ScreenshotsHelp"))
+    end
+  end
+end

data/spec/example_deliver_files_spec.rb

@@ -0,0 +1,227 @@
+describe Deliver do
+  describe Deliver::Deliverer do
+    describe "#initialize" do
+      describe "Different Deliverfiles" do
+        it "raises an error when file was not found" do
+          expect {
+            Deliver::Deliverer.new(nil)
+          }.to raise_exception "Deliverfile not found at path './Deliverfile'".red
+        end
+
+        it "raises an error if some key information is missing" do
+          expect {
+            Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileMissingAppVersion")
+          }.to raise_exception("You have to pass a valid version number using the Deliver file. (e.g. 'version \"1.0\"')".red)
+
+          expect {
+            Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileMissingIdentifier")
+          }.to raise_exception("You have to pass a valid app identifier using the Deliver file. (e.g. 'app_identifier \"net.sunapps.app\"')".red)
+
+          expect {
+            Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileMissingLanguage")
+          }.to raise_exception(Deliver::Deliverfile::Deliverfile::DSL::SPECIFY_LANGUAGE_FOR_VALUE.red)
+        end
+
+        it "throws an exception when both ipa and beta_ipa are given" do
+          expect {
+            Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileDuplicateIpa")
+          }.to raise_exception("You can not set both ipa and beta_ipa in one file. Either it's a beta build or a release build".red)
+        end
+
+        it "throws an exception when block does not return anything" do
+          expect {
+            Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileMissingValue")
+          }.to raise_exception("You have to pass either a value or a block to the given method.".red)
+        end
+
+        it "throws an exception when no block is given for tests" do
+          expect {
+            Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileMissingBlockForTests")
+          }.to raise_exception("Value for unit_tests must be a Ruby block. Use 'unit_tests' do ... end.".red)
+        end
+
+        it "throws an exception when default_language is not on top of file" do
+          expect {
+            Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileDefaultLanguageNotOnTop")
+          }.to raise_exception("'default_language' must be on the top of the Deliverfile.".red)
+        end
+
+        describe "Valid Deliverfiles" do
+          before do
+            Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/download_valid_apple_id.txt")
+          end
+
+          it "successfully loads the Deliverfile if it's valid" do
+            Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+
+            meta = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileSimple")
+
+            thanks_for_facebook = "Thanks for using Facebook! To make our app better for you, we bring updates to the App Store every 4 weeks."
+
+            expect(meta.deliver_process.app.app_identifier).to eq("net.sunapps.54")
+            expect(meta.deliver_process.deploy_information[:version]).to eq("943.0")
+            expect(meta.deliver_process.deploy_information[:changelog]).to eq({
+              'en-US' => thanks_for_facebook
+            })
+
+            # Stored in XML file
+            expect(meta.deliver_process.app.metadata.fetch_value("//x:version").first['string']).to eq("943.0")
+            expect(meta.deliver_process.app.metadata.fetch_value("//x:version_whats_new").count).to eq(1) # one language only
+            expect(meta.deliver_process.app.metadata.fetch_value("//x:version_whats_new").first.content).to eq(thanks_for_facebook)
+          end
+
+          it "Sets all the available metadata" do
+            Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+
+            meta = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileMixed")
+
+            expect(meta.deliver_process.app.app_identifier).to eq("net.sunapps.54")
+
+            expect(meta.deliver_process.deploy_information[:changelog]).to eq({"en-US"=>"Thanks for using this app"})
+            expect(meta.deliver_process.deploy_information[:version]).to eq("943.0")
+            expect(meta.deliver_process.deploy_information[:description]).to eq({"en-US"=>"App description"})
+            expect(meta.deliver_process.deploy_information[:privacy_url].values.first).to eq("http://privacy.sunapps.net")
+            expect(meta.deliver_process.deploy_information[:marketing_url].values.first).to eq("http://www.sunapps.net")
+            expect(meta.deliver_process.deploy_information[:support_url].values.first).to eq("http://support.sunapps.net")
+            expect(meta.deliver_process.deploy_information[:title]).to eq({"en-US"=>"The ultimate iPhone app"})
+            expect(meta.deliver_process.deploy_information[:keywords]).to eq({"en-US"=>["keyword1", "something", "else"]})
+          end
+
+          it "Uploads all the available screenshots" do
+            Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+            deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileScreenshots")
+            screenshots = deliv.deliver_process.app.metadata.fetch_value("//x:software_screenshot")
+            expect(screenshots.count).to eq(9)
+
+            screenshots_path = "spec/fixtures/packages/#{deliv.deliver_process.app.apple_id}.itmsp/*.png"
+            expect(Dir.glob(screenshots_path).count).to equal(screenshots.count)
+            Dir.glob(screenshots_path) do |file|
+              File.delete(file)
+            end
+          end
+
+          it "Falls back to the default language if only one screenshot path is given" do
+            Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+
+            deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileScreenshotsFallbackDefaultLanguage")
+            expect(deliv.deliver_process.deploy_information[:screenshots_path]).to eq({"de-DE"=>"/tmp"})
+          end
+
+          it "Does not require an app version, when an ipa is given" do
+            Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+            Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt") # the ipa file
+            deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileNoVersion")
+
+            expect(deliv.deliver_process.app.apple_id).to eq(464686641)
+            expect(deliv.deliver_process.app.app_identifier).to eq('at.felixkrause.iTanky')
+            expect(deliv.deliver_process.deploy_information.values.count).to eq(3)
+          end
+
+          it "Let's the user specify which languages should be supported" do
+            Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+
+            deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileLocales")
+
+            metadata = deliv.deliver_process.app.metadata
+            expect(metadata.fetch_value("//x:locale").count).to eq(3)
+            expect(metadata.fetch_value("//x:title").count).to eq(3)
+
+            expect(metadata.information['de-DE'][:title][:value]).to eq("Deutscher Titel")
+            expect(metadata.information['en-US'][:title][:value]).to eq("The ultimate iPhone app")
+            expect(metadata.information['en-GB'][:title][:value]).to eq("The ultimate iPhone app") # default language
+
+            expect(metadata.information['de-DE'][:version_whats_new][:value]).to eq("Deutscher Changelog")
+            expect(metadata.information['en-US'][:version_whats_new][:value]).to eq("Thanks for using this app")
+            expect(metadata.information['en-GB'][:version_whats_new][:value]).to eq("So british")
+          end
+
+          describe "#load_config_json_folder" do
+            it "Correctly parses all the values for all the languages" do
+              Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+              deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileMetadataJson")
+
+              expect(deliv.deliver_process.deploy_information[:title].values.count).to eq(2) # languages
+              expect(deliv.deliver_process.deploy_information[:title]['de-DE']).to eq("Mein App Titel")
+              expect(deliv.deliver_process.deploy_information[:title]['en-US']).to eq("My App Title")
+              expect(deliv.deliver_process.deploy_information[:description]['de-DE']).to eq("German Description")
+              expect(deliv.deliver_process.deploy_information[:description]['en-US']).to eq("English Description here")
+              expect(deliv.deliver_process.deploy_information[:keywords]['de-DE'].last).to eq("Tag1")
+              expect(deliv.deliver_process.deploy_information[:keywords]['en-US'].last).to eq("Keyword1")
+            end
+          end
+
+          describe "Test Deliver Callback blocks" do
+            before do
+              path = "/tmp/"
+              @tests_path = "#{path}/deliver_unit_tests.txt"
+              @success_path = "#{path}/deliver_success.txt"
+              @error_path = "#{path}/deliver_error.txt"
+              paths = [@tests_path, @success_path, @error_path]
+
+              # Delete files from previous runs
+              paths.each do |current|
+                File.delete(current) if File.exists?current
+              end
+            end
+
+            it "Successful" do
+              expect(File.exists?@tests_path).to eq(false)
+              Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+              Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt") # the ipa file
+              deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileCallbacks")
+              expect(File.exists?@tests_path).to eq(true)
+              expect(File.exists?@success_path).to eq(true)
+              expect(File.exists?@error_path).to eq(false)
+            end
+
+            it "Error on ipa upload" do
+              Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_valid.txt")
+              Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_invalid.txt") # the ipa file
+              deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileCallbacks")
+              expect(File.exists?@tests_path).to eq(true)
+              expect(File.exists?@success_path).to eq(false)
+              expect(File.exists?@error_path).to eq(true)
+            end
+
+            it "Error on app metadata upload" do
+              Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/upload_invalid.txt")
+              deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileCallbacks")
+              expect(File.exists?@tests_path).to eq(true)
+              expect(File.exists?@success_path).to eq(false)
+              expect(File.exists?@error_path).to eq(true)
+            end
+
+            it "Error on unit tests" do
+              Deliver::ItunesTransporter.clear_mock_files # since we don't even download the metadata
+
+              expect(File.exists?@tests_path).to eq(false)
+              deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileCallbacksFailingTests")
+              expect(File.exists?@tests_path).to eq(true)
+              expect(File.exists?@success_path).to eq(false)
+              expect(File.exists?@error_path).to eq(true)
+            end
+
+            it "Error on unit tests with no error block raises an exception" do
+              Deliver::ItunesTransporter.clear_mock_files # since we don't even download the metadata
+              expect {
+                deliv = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileCallbacksNoErrorBlock")
+              }.to raise_exception("Unit tests failed. Got result: 'false'. Need 'true' or 1 to succeed.".red)
+            end
+          end
+        end
+
+        it "raises an exception if app identifier of ipa does not match the given one" do
+          expect {
+            meta = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileWrongIdentifier")
+          }.to raise_exception("App Identifier of IPA does not match with the given one ('net.sunapps.321' != 'at.felixkrause.iTanky')".red)
+        end
+
+        it "raises an exception if app version of ipa does not match the given one" do
+          expect {
+            meta = Deliver::Deliverer.new("./spec/fixtures/Deliverfiles/DeliverfileWrongVersion")
+          }.to raise_exception("App Version of IPA does not match with the given one (128378973 != 1.0)".red)
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/Deliverfiles/DeliverfileCallbacks

@@ -0,0 +1,14 @@
+ipa "./spec/fixtures/ipas/Example1.ipa"
+
+unit_tests do
+  File.write('/tmp/deliver_unit_tests.txt', Time.now.to_i)
+  true # to indicate everything's alright
+end
+
+success do
+  File.write('/tmp/deliver_success.txt', Time.now.to_i)
+end
+
+error do
+  File.write('/tmp/deliver_error.txt', Time.now.to_i)
+end

data/spec/fixtures/Deliverfiles/DeliverfileCallbacksFailingTests

@@ -0,0 +1,14 @@
+ipa "./spec/fixtures/ipas/Example1.ipa"
+
+unit_tests do
+  File.write('/tmp/deliver_unit_tests.txt', Time.now.to_i)
+  false
+end
+
+success do
+  File.write('/tmp/deliver_success.txt', Time.now.to_i)
+end
+
+error do |exception|
+  File.write('/tmp/deliver_error.txt', exception)
+end

data/spec/fixtures/Deliverfiles/DeliverfileCallbacksNoErrorBlock

@@ -0,0 +1,6 @@
+ipa "./spec/fixtures/ipas/Example1.ipa"
+
+unit_tests do
+  File.write('/tmp/deliver_unit_tests.txt', Time.now.to_i)
+  false
+end

data/spec/fixtures/Deliverfiles/DeliverfileDefaultLanguageNotOnTop

@@ -0,0 +1,8 @@
+
+changelog({
+  'en-US' => "Thanks for using this app",
+  'de-DE' => "Deutscher Changelog",
+  'en-GB' => "So british"
+})
+
+default_language 'de-DE'

data/spec/fixtures/Deliverfiles/DeliverfileDuplicateIpa

@@ -0,0 +1,2 @@
+ipa './spec/fixtures/ipas/Example1.ipa'
+beta_ipa './spec/fixtures/ipas/Example1.ipa'

data/spec/fixtures/Deliverfiles/DeliverfileLocales

@@ -0,0 +1,16 @@
+
+version '943.0'
+
+app_identifier 'net.sunapps.54'
+apple_id 'id878567776'
+
+changelog({
+  'en-US' => "Thanks for using this app",
+  'de-DE' => "Deutscher Changelog",
+  'en-GB' => "So british"
+})
+
+title({
+  'en-US' => "The ultimate iPhone app",
+  'de-DE' => "Deutscher Titel"
+})

data/spec/fixtures/Deliverfiles/DeliverfileMetadataJson

@@ -0,0 +1,6 @@
+app_identifier "net.sunapps.54"
+apple_id 794902327
+
+version '1.2' # you can pass this if you want to verify the version number with the ipa file
+
+config_json_folder './spec/fixtures/Deliverfiles/metadata.json'

data/spec/fixtures/Deliverfiles/DeliverfileMissingAppVersion

@@ -0,0 +1 @@
+app_identifier "net.sunapps.1"

data/spec/fixtures/Deliverfiles/DeliverfileMissingBlockForTests

@@ -0,0 +1,7 @@
+
+version '943.0'
+
+app_identifier 'net.sunapps.54'
+apple_id 'id878567776'
+
+unit_tests 1

data/spec/fixtures/Deliverfiles/DeliverfileMissingIdentifier

@@ -0,0 +1 @@
+version "1.0"