deliver 0.0.1 → 0.1.0

data/lib/deliver/version.rb

@@ -1,3 +1,3 @@
 module Deliver
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/app_metadata_spec.rb

@@ -0,0 +1,350 @@
+describe Deliver do
+  describe Deliver::AppMetadata do
+    let (:apple_id) { 794902327 }
+    let (:app_identifier) { 'net.sunapps.1' }
+
+    [
+      "./spec/fixtures/example1.itmsp/",
+      "./spec/fixtures/example2.itmsp/"
+    ].each do |current_path|
+      describe "Example metadata #{current_path.split('/').last}" do
+        before do
+          @app = Deliver::App.new(apple_id: apple_id, app_identifier: app_identifier)
+
+          @app.metadata = Deliver::AppMetadata.new(@app, current_path, false)
+
+          @number_of_screenshots = (current_path.include?("example1") ? 8 : 0)
+        end
+
+        it "properly cleaned up the live version, which cannot be updated" do
+          expect(@app.metadata.fetch_value("//x:version").count).to eq(1)
+          expect(@app.metadata.fetch_value("//x:version").first['string']).to eq("0.9.10")
+        end
+
+        if current_path.include?'example1'
+          it "properly loaded all the app metadata into the information hash" do
+            info = @app.metadata.information['de-DE']
+            expect(info[:title][:value]).to eq("Example App Title")
+            expect(info[:title][:modified]).to eq(false)
+            expect(info[:description][:value].include?"3D GPS Birdiebuch").to eq(true)
+            expect(info[:keywords][:value]).to eq(%w|personal sunapps sun sunapps felix krause|)
+            expect(info[:version_whats_new][:value]).to eq("- Changelog Line 1\n- Changelog Line 2")
+            expect(info[:software_url][:value]).to eq("http://sunapps.net")
+            expect(info[:support_url][:value]).to eq("http://www.sunapps.net/")
+
+            expect(@app.metadata.information.count).to eq(2)
+          end
+        end
+
+        describe "#update_title" do
+
+          it "updates the title" do
+            new_title = "So new title"
+
+            expect(@app.metadata.fetch_value("//x:title").last.content).to eq('Example App Title')
+            @app.metadata.update_title({ 'de-DE' => new_title })
+
+            expect(@app.metadata.fetch_value("//x:title").last.content).to eq(new_title)
+          end
+
+          it "supports the & symbol properly" do
+            new_title = "something & something else"
+            @app.metadata.update_title({ 'de-DE' => new_title })
+
+            expect(@app.metadata.fetch_value("//x:title").last.content).to eq(new_title)
+          end
+
+          it "raises an error when passing an invalid language" do
+            begin
+              @app.metadata.update_title({ 'de' => 'asdf' })
+              raise "No exception was raised"
+            rescue Exception => ex
+              expect(ex.to_s).to include("Language 'de' is invalid. It must be in [")
+            end
+          end
+        end
+
+        describe "#add_new_locale" do
+          it "throws an exception when an invalid language was passed" do
+            expect {
+              @app.metadata.add_new_locale('asdf')
+            }.to raise_error(/is invalid. It must be in/)
+          end
+
+          it "throws return false when languag already exists" do
+            expect(@app.metadata.add_new_locale('es-ES')).to eq(true)
+            expect(@app.metadata.add_new_locale('es-ES')).to eq(false)
+          end
+
+          it "adds a new language if it's valid" do
+            expect(@app.metadata.add_new_locale('es-ES')).to eq(true)
+
+            expect(@app.metadata.fetch_value("//x:locale").count).to eq(3)
+            expect(@app.metadata.fetch_value("//x:title").count).to eq(3)
+
+            @app.metadata.fetch_value("//x:title").each do |current|
+              # it properly set the default title to be valid
+              expect(current.content.length).to be > 5
+            end
+          end
+        end
+
+        describe "#update_description" do
+
+          it "throws an exception when a string is given instead of a hash" do
+            expect {
+              @app.metadata.update_description("something")
+            }.to raise_error("Please pass a hash of languages to this method")
+          end
+
+          it "updates the description when a hash is given" do
+            description = "Something Deutsch"
+
+            expect(@app.metadata.information['de-DE'][:description][:modified]).to eq(false)
+
+            @app.metadata.update_description({
+              'de-DE' => description
+            })
+            
+            expect(@app.metadata.fetch_value("//x:description").first.content).to eq(description)
+
+            expect(@app.metadata.information['de-DE'][:description][:value]).to eq(description)
+            expect(@app.metadata.information['de-DE'][:description][:modified]).to eq(true)
+          end
+        end
+
+        describe "#update_changelog" do
+          it "updates the changelog" do
+            new_value = "What's new?"
+            @app.metadata.update_changelog({ 'de-DE' => new_value })
+            expect(@app.metadata.fetch_value("//x:version_whats_new").first.content).to eq(new_value)
+          end
+        end
+
+        describe "#update_marketing_url" do
+          it "updates the marketing URL" do
+            new_value = "http://google.com"
+            expect(@app.metadata.fetch_value("//x:software_url").first.content).to eq('http://sunapps.net')
+            @app.metadata.update_marketing_url({ 'de-DE' => new_value })
+            expect(@app.metadata.fetch_value("//x:software_url").first.content).to eq(new_value)
+          end
+        end
+
+        describe "#update_support_url" do
+          it "updates the support URL" do
+            new_value = "http://krause.pizza"
+            expect(@app.metadata.fetch_value("//x:support_url").first.content).to eq('http://www.sunapps.net/')
+            @app.metadata.update_support_url({ 'de-DE' => new_value })
+            expect(@app.metadata.fetch_value("//x:support_url").first.content).to eq(new_value)
+          end
+
+          it "doesn't set the modified to true if it's the same value" do
+            old = @app.metadata.information['de-DE'][:support_url][:value]
+            expect(@app.metadata.information['de-DE'][:support_url][:modified]).to eq(false)
+
+            @app.metadata.update_support_url({'de-DE' => old})
+
+            expect(@app.metadata.information['de-DE'][:support_url][:modified]).to eq(false)
+
+            @app.metadata.update_support_url({'de-DE' => 'something new'})
+
+            expect(@app.metadata.information['de-DE'][:support_url][:modified]).to eq(true)
+          end
+        end
+
+        describe "#update_privacy_url" do
+          it "updates the privacy URL" do
+            new_value = "http://krause.pizza"
+            expect(@app.metadata.fetch_value("//x:privacy_url").first).to eq(nil)
+
+            @app.metadata.update_privacy_url({ 'de-DE' => new_value })
+
+            expect(@app.metadata.fetch_value("//x:privacy_url").first.content).to eq(new_value)
+            expect(@app.metadata.information['de-DE'][:privacy_url][:value]).to eq(new_value)
+            expect(@app.metadata.information['de-DE'][:privacy_url][:modified]).to eq(true)
+          end
+        end
+
+
+        describe "#update_keywords" do
+          it "throws an exception when a string is given instead of an array" do
+            expect {
+              @app.metadata.update_keywords({ "de-DE" => "keyword1, keyword2" })
+            }.to raise_error("Parameter needs to be a hash (each language) with an array of keywords in it (given: {\"de-DE\"=>\"keyword1, keyword2\"})")
+          end
+
+          it "updates the keywords when a hash of arrays is given" do
+            tags = ["SunApps", "Felix", "Krause"]
+
+            @app.metadata.fetch_value("//x:keyword")
+
+            @app.metadata.update_keywords({
+              'de-DE' => tags
+            })
+            
+            result = @app.metadata.fetch_value("//x:keyword")
+            expect(result.count).to eq(tags.count)
+            expect(result[0].content).to eq(tags[0])
+            expect(result[1].content).to eq(tags[1])
+            expect(result[2].content).to eq(tags[2])
+          end
+        end
+
+        describe "#clear_all_screenshots" do
+          it "clears all the screenshots of the given language" do
+            expect(@app.metadata.fetch_value("//x:software_screenshot").count).to eq(0)
+
+            path = './spec/fixtures/screenshots/screenshot1.png'
+            @app.metadata.set_all_screenshots({
+              'de-DE' => [
+                Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_40)
+              ]
+            })
+
+            expect(@app.metadata.fetch_value("//x:software_screenshot").count).to eq(1)
+
+            @app.metadata.clear_all_screenshots("de-DE")
+
+            expect(@app.metadata.fetch_value("//x:software_screenshot").count).to eq(0)
+          end
+
+          it "throws an exception when language is invalid" do
+            expect {
+              @app.metadata.clear_all_screenshots("de")
+            }.to raise_error("The specified language could not be found. Make sure it is available in Deliver::Languages::ALL_LANGUAGES")
+          end
+        end
+
+        describe "#set_all_screenshots" do
+          let (:error_message) { "Please pass a hash, containing an array of AppScreenshot objects" }
+          it "raises an error when not passing a hash" do
+            expect {
+              @app.metadata.set_all_screenshots([])
+            }.to raise_error(error_message)
+          end
+
+          it "raises an error when passing empty arrays" do
+            expect {
+              @app.metadata.set_all_screenshots({ 'de-DE' => [] })
+            }.to raise_error(error_message)
+          end
+
+          it "raises an error when not using AppScreenshot objects" do
+            expect {
+              @app.metadata.set_all_screenshots({ 'de-DE' => ["./screenshot.png"] })
+            }.to raise_error(error_message)
+          end
+
+          it "properly updates the metadata information when providing correct inputs" do
+            path = './spec/fixtures/screenshots/screenshot1.png'
+
+            expect(@app.metadata.fetch_value("//x:software_screenshot").count).to eq(0)
+            @app.metadata.set_all_screenshots({
+              'de-DE' => [
+                Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_40),
+                Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_40),
+                Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_40)
+              ]
+            })
+            results = @app.metadata.fetch_value("//x:software_screenshot")
+            expect(results.count).to eq(3)
+            expect(results[0]['position']).to eq('1')
+            expect(results[1]['position']).to eq('2')
+            expect(results[2]['position']).to eq('3')
+          end
+        end
+
+        describe "#set_screenshots_for_each_language" do
+          it "automatically detects all screenshots in the given folder" do
+            @app.metadata.clear_all_screenshots("de-DE")
+            @app.metadata.clear_all_screenshots("en-US")
+
+            path = './spec/fixtures/screenshots/de-DE'
+            expect(@app.metadata.set_screenshots_for_each_language({'de-DE' => path})).to eq(true)
+            results = @app.metadata.fetch_value("//x:software_screenshot")
+            
+            expect(results.count).to eq(Dir["./spec/fixtures/screenshots/de-DE/*"].length)
+            
+            example = results.first
+            expect(example['display_target']).to eq("iOS-3.5-in")
+            expect(example['position']).to eq("1")
+
+            expect(results[1]['position']).to eq("1") # other screen size
+          end
+        end
+
+        describe "#set_all_screenshots_from_path" do
+          it "return false if no folders could be found" do
+            expect(@app.metadata.set_all_screenshots_from_path('./notfound')).to equal(false)
+          end
+
+          it "automatically detects all screenshots in the given folder" do
+            @app.metadata.clear_all_screenshots("de-DE")
+            @app.metadata.clear_all_screenshots("en-US")
+
+            path = './spec/fixtures/screenshots/'
+            expect(@app.metadata.set_all_screenshots_from_path(path)).to equal(true)
+
+            results = @app.metadata.fetch_value("//x:software_screenshot")
+
+            expect(results.count).to eq(Dir["./spec/fixtures/screenshots/de-DE/*"].length + 
+                                      Dir["./spec/fixtures/screenshots/en-US/*"].length)
+            
+            example = results.first
+            expect(example['display_target']).to eq("iOS-4-in")
+            expect(example['position']).to eq("1")
+
+            expect(results[1]['position']).to eq("1") # other screen size
+          end
+
+          it "throws an exception when there are too many screenshots" do
+            expect {
+              @app.metadata.set_all_screenshots_from_path('./spec/fixtures/screenshots/tooMany/')
+            }.to raise_error("Only 5 screenshots are allowed per language per device type (iOS-3.5-in)")
+          end
+        end
+
+        describe "#add_screenshot" do
+          it "allows the user to add multiple screenshots" do
+            @app.apple_id = 878567776
+            @app.metadata.clear_all_screenshots('de-DE')
+            @app.metadata.clear_all_screenshots('en-US')
+            expect(@app.metadata.fetch_value("//x:software_screenshot").count).to eq(0)
+
+            path = './spec/fixtures/screenshots/screenshot1.png'
+            # The order is quite important. en-US first, since we check using the index afterwards
+            @app.metadata.add_screenshot('en-US', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_47))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_55))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_55))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_47))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_55))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_IPAD))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_IPAD))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_IPAD))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_IPAD))
+            @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_IPAD))
+
+            expect {
+              @app.metadata.add_screenshot('de-DE', Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_IPAD))
+            }.to raise_error("Only 5 screenshots are allowed per language per device type (iOS-iPad)")
+            
+
+            results = @app.metadata.fetch_value("//x:software_screenshot")
+            expect(results.count).to eq(10)
+
+            expect(results[0]['position']).to eq('1')
+            expect(results[1]['position']).to eq('1')
+            expect(results[2]['position']).to eq('2')
+            expect(results[3]['position']).to eq('1')
+            expect(results[4]['position']).to eq('3')
+            expect(results[5]['position']).to eq('1')
+            expect(results[6]['position']).to eq('2')
+            expect(results[7]['position']).to eq('3')
+            expect(results[8]['position']).to eq('4')
+            expect(results[9]['position']).to eq('5')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/app_screenshot_spec.rb

@@ -0,0 +1,88 @@
+describe Deliver do
+  describe Deliver::AppScreenshot do
+    let (:path) { "./spec/fixtures/screenshots/screenshot1.png" }
+
+    describe "#init" do
+      it "raises an exception if image file was not found" do
+        path = "./notHere.png"
+        expect {
+          Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_40)
+        }.to raise_error("File not found at path '#{path}'")
+      end
+
+      it "properly saves the path and screen size" do
+        res = Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_40)
+        expect(res.path).to eq(path)
+        expect(res.screen_size).to eq(Deliver::ScreenSize::IOS_40)
+      end
+    end
+
+    describe "after init" do
+      before do
+        @item = Deliver::AppScreenshot.new(path, Deliver::ScreenSize::IOS_40)
+        @doc = Nokogiri::XML(File.read("./spec/fixtures/example1.itmsp/metadata.xml"))
+      end
+
+      describe "#create_xml_node" do
+        it "properly creates a valid nokogiri xml node for the screenshot" do
+          order_index = 1
+          node = @item.create_xml_node(@doc, order_index)
+          expect(node.children.first.content).to eq(File.size(path).to_s)
+          expect(node.children[1].content).to eq("30fbc3071dc36b824bcd5960bcfef775.png")
+          expect(node.children.last['type']).to eq("md5")
+          expect(node.children.last.content).to eq("e2c116d8f1ab7982a2b131ac681b6e86")
+
+          expect(node['position']).to eq(order_index.to_s)
+          expect(node['display_target']).to eq(Deliver::ScreenSize::IOS_40)
+        end
+      end
+
+      describe "#is_valid?" do
+        it "is not valid when it's not a png" do
+          expect(@item.is_valid?).to eq(true)
+
+          @item.path = "./something.jpg"
+          expect(@item.is_valid?).to eq(false)
+        end
+
+        it "it is not valid, when the size does not match the given type" do
+          expect(@item.is_valid?).to eq(true)
+
+          @item.screen_size = Deliver::ScreenSize::IOS_55
+          expect(@item.is_valid?).to eq(false) # wrong size
+        end
+      end
+
+      describe "#calculate_screen_size" do
+        it "will raise an error if the file can not be found" do
+          expect {
+            Deliver::AppScreenshot.calculate_screen_size('./notHere.png')
+          }.to raise_error("Could not find or parse file at path './notHere.png'")
+        end
+
+        it "will raise an error if the size is invalid" do
+          expect {
+            Deliver::AppScreenshot.calculate_screen_size('./spec/fixtures/screenshots/invalidImage.png')
+          }.to raise_error("Unsupported screen size [20, 36] for path './spec/fixtures/screenshots/invalidImage.png'")
+        end
+
+        it "it will return the size for a given png file" do
+          p = "./spec/fixtures/screenshots/de-DE/"
+
+          files = [
+            ['iPhone4.png', 'iOS-3.5-in'],
+            ['iPhone6.png', 'iOS-4.7-in'],
+            ['iPhone6Plus1.png', 'iOS-5.5-in'],
+            ['iPhone6Plus2.png', 'iOS-5.5-in'],
+            ['screenshot1.png', 'iOS-4-in']
+          ]
+
+          files.each do |value|
+            expect(Deliver::AppScreenshot.calculate_screen_size(p + value[0])).to eq(value[1])
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/app_spec.rb

@@ -0,0 +1,85 @@
+describe Deliver do
+  describe Deliver::App do
+    let (:apple_id) { 284882215 }
+    let (:app_identifier) { 'com.facebook.Facebook' }
+
+    describe "#initialize" do
+      it "automatically fetches the app identifier, if only Apple ID is given" do
+        app = Deliver::App.new(apple_id: apple_id)
+
+        expect(app.app_identifier).to eq(app_identifier)
+        expect(app.apple_id).to eq(apple_id)
+      end
+
+      it "lets me create an app using an Apple ID and app identifier" do
+        app = Deliver::App.new(apple_id: apple_id,
+                              app_identifier: app_identifier)
+
+        expect(app.app_identifier).to eq(app_identifier)
+        expect(app.apple_id).to eq(apple_id)
+      end
+
+      it "lets me create an app without any information given (yet)" do
+        expect(Deliver::App.new.app_identifier).to eq(nil)
+      end
+
+      it "raises an exception if given app identifier is invalid" do
+        expect {
+          Deliver::App.new(app_identifier: 'net.sunapps.invalid')
+        }.to raise_error("Please pass a valid Apple ID using 'apple_id'".red)
+      end
+    end
+
+    describe "#to_s" do
+      it "returns a well formatted string" do
+        app = Deliver::App.new(apple_id: apple_id)
+        expect(app.to_s).to eq("#{apple_id} - #{app_identifier}")
+      end
+    end
+
+    describe "Accessing App Metadata" do
+      let (:apple_id) { 794902327 }
+      before do
+        @app = Deliver::App.new(apple_id: apple_id, app_identifier: 'net.sunapps.1')
+      end
+
+      describe "#metadata_downloaded?" do
+        it "return false if not done yet" do
+          Deliver::ItunesTransporter.set_mock_file("spec/responses/transporter/download_valid_apple_id.txt")
+
+          expect(@app.metadata_downloaded?).to eq(false)
+          @app.metadata
+          expect(@app.metadata_downloaded?).to eq(true)
+        end
+      end
+
+      describe "#set_metadata_directory" do
+
+        it "throws an exception when updating the location after accessing metadata" do
+          @app.metadata = Deliver::AppMetadata.new(@app, "./spec/fixtures/example1.itmsp/", false)
+          expect {
+            @app.set_metadata_directory("something")
+          }.to raise_error("Can not change metadata directory after accessing metadata of an app")
+        end
+
+        it "let's the user modify the download directory" do
+          expect(@app.get_metadata_directory).to eq("./spec/fixtures/packages/")
+
+          alternative = '/tmp/'
+          @app.set_metadata_directory(alternative)
+
+          expect(@app.get_metadata_directory).to eq(alternative)
+        end
+
+      end
+
+      describe "#upload_metadata!" do
+        it "throws an exception when metadata was not yet downloaded" do
+          expect { 
+            @app.upload_metadata!
+          }.to raise_error("You first have to modify the metadata using app.metadata.setDescription")
+        end
+      end
+    end
+  end
+end