Update Swift, ObjC examples code to showcase keygen and passphrase APIs #688

vixentael · 2020-07-29T15:16:32Z

During working on reproducing #687 I've noticed that Swift examples code doesn't show new SymmetricKeygen API and EncryptWithPassphrase API.

I've updated example projects to include usage of this API:

swift

iOS-Carthage
iOS-CocoaPods
macOS-Carthage

objc

iOS-Carthage
iOS-CocoaPods
macOS-Carthage

Checklist

~~- [ ] Change is covered by automated tests~~
~~- [ ] Benchmark results are attached (if applicable)~~
~~- [ ] Public API has proper documentation~~

The coding guidelines are followed
Changelog is updated (in case of notable or breaking changes)
Example projects and code samples are up-to-date (in case of API changes)

vixentael · 2020-07-29T15:18:06Z

docs/examples/swift/iOS-Carthage/Cartfile.resolved

@@ -1,2 +1,2 @@
-github "cossacklabs/themis" "0.13.0"
+github "cossacklabs/themis" "gothemis/v0.13.0"


this is truly funny

-github "cossacklabs/themis" "0.13.0" +github "cossacklabs/themis" "gothemis/v0.13.0"

No idea why this happens. It does not happen with "0.12.0", for example, which also has gothemis/v0.12.0 pointing to the same commit. Maybe Carthage does not like annotated signed tags?..

Well, I guess we can leave it like this since that's what users will be get in their projects. And the tags aren't going anywhere. But I'd like to have some fairies come and fix it ☁️

ilammy

The changes seem okay, but I guess there is a bit more work to be done.

Also, what about Objective-C samples?

ilammy · 2020-07-29T15:30:44Z

docs/examples/swift/iOS-Carthage/Cartfile.resolved

@@ -1,2 +1,2 @@
-github "cossacklabs/themis" "0.13.0"
+github "cossacklabs/themis" "gothemis/v0.13.0"


-github "cossacklabs/themis" "0.13.0" +github "cossacklabs/themis" "gothemis/v0.13.0"

No idea why this happens. It does not happen with "0.12.0", for example, which also has gothemis/v0.12.0 pointing to the same commit. Maybe Carthage does not like annotated signed tags?..

Well, I guess we can leave it like this since that's what users will be get in their projects. And the tags aren't going anywhere. But I'd like to have some fairies come and fix it ☁️

ilammy · 2020-07-29T15:33:12Z

docs/examples/swift/iOS-Carthage/ThemisTest/AppDelegate.swift

+        // generate key from pre-defined string
+        print("Using key from pre-defined string")
+        let keyFromString = self.generateMasterKey()


I'd suggest to stop calling it generateMasterKey(), just put a constant here, and call it, like, fixedKey.

The TSGenerateSymmetricKey() is the preferred generator that we'd like to teach to the users.

ilammy · 2020-07-29T15:34:22Z

docs/examples/swift/iOS-CocoaPods/ThemisSwift/ThemisSwift.xcodeproj/project.pbxproj

-				SWIFT_VERSION = 4.2;
+				SWIFT_VERSION = 5.0;


I believe other example projects need to be updated to use Swift 5.0 as well.

interestingly, Carthage example uses 5.0

ilammy · 2020-07-29T15:38:29Z

...les/swift/iOS-CocoaPods/ThemisSwift/ThemisSwift/Resources/Base.lproj/LaunchScreen.storyboard

-                            <label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="Copyright (c) 2015-2019 Cossack Labs. All rights reserved." textAlignment="center" lineBreakMode="tailTruncation" numberOfLines="0" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="SDJ-TG-gQB">
+                            <label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="Copyright (c) 2015-2020 Cossack Labs. All rights reserved." textAlignment="center" lineBreakMode="tailTruncation" numberOfLines="0" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="SDJ-TG-gQB">


This isn't the only project with an outdated copyright line.

$ git grep -o 'Copyright (c) .* All rights reserved.' docs/examples/Themis-server/Obj-C/WorkingWithThemisServer/WorkingWithThemisServer/Base.lproj/LaunchScreen.storyboard:Copyright (c) 2015-2019 Cossack Labs. All rights reserved. docs/examples/Themis-server/swift/SwiftThemisServerExample/SwiftThemisServerExample/Base.lproj/LaunchScreen.storyboard:Copyright (c) 2015-2019 Cossack Labs. All rights reserved. docs/examples/objc/iOS-CocoaPods/ThemisTest/ThemisTest/Resources/Base.lproj/LaunchScreen.xib:Copyright (c) 2015-2019 Cossack Labs. All rights reserved." textAlignment="center" lineBreakMode="tailTruncation" baselineAdjustment="alignBaselines" minimumFontSize="9" translatesAutoresizingMaskIntoConstraints="NO" id="8ie-xW-0ye" userLabel="Copyright (c) 2015-2017 Cossack Labs. All rights reserved. docs/examples/objc/iOS-CocoaPods/ThemisTest/ThemisTestTests/ThemisTestTests.m:Copyright (c) 2015 Cossack Labs. All rights reserved. docs/examples/swift/iOS-CocoaPods/ThemisSwift/ThemisSwift/Resources/Base.lproj/LaunchScreen.storyboard:Copyright (c) 2015-2019 Cossack Labs. All rights reserved.

Also, how about leaving only the date when the company assumes copyright, implying that it's still actual in the present? That would save us the trouble of doing or forgetting to do pointless updates every year.

yeah, makes sense

removed copyright label at all from all projects, except Themis-server

vixentael · 2020-07-29T22:31:23Z

Also, what about Objective-C samples?

done :)

CHANGELOG.md

upd changelog

CHANGELOG.md

ilammy · 2020-07-30T07:09:28Z

docs/examples/objc/iOS-Carthage/ThemisTest/AppDelegate.m

+    NSString * message = @"All your base are belong to us!";
+    NSString * context = @"For great justice";
+    NSError * themisError;


Ｉｓ　ｔｈｉｓ　ｒｅａｌｌｙ　ｔｈｅ　ｐｒｅｆｅｒｒｅｄ　ｃｏｄｅ　ｓｔｙｌｅ　？

I mean , Apple docs definitely don ' t use punctuation like this . It also brings a lot of diff noise .

¯_(ツ)_/¯
i aligned the code styles with that one that we've used in other examples.

Okay, my fault for not adding code formatters. clang-format should do the trick for Objective-C and swift-format should work for Swift.

Well, I can agree to tolerate this but only because a) there is no formal code style, b) there are no formatters, c) a merit of unifying the style is displayed. Though, I can challenge the last point:

Project Code style

docs/examples/objc/iOS-Carthage 1️⃣ NSString *message

docs/examples/objc/iOS-CocoaPods 2️⃣ NSString * message

docs/examples/objc/macOS-Carthage 1️⃣ NSString *message

docs/examples/Themis-server/Obj-C 2️⃣ NSString * base64Body

src/wrappers/themis/Obj-C/objcthemis 1️⃣ NSMutableData *unwrappedMessage

tests/objcthemis/objthemis 2️⃣ NSString * sharedSecret

(So it's actually a tie. I won't count the lines.)

But FWIW, I'd personally keep whatever format is there in the files and use the same format for new code added there. The only acceptable reason for massive diff noise is some automated reformatting to the format which is going to be enforced later. If that's the thing, it should be in a separate PR anyway, not in the one which adds some new examples.

Co-authored-by: Alexei Lozovsky <[email protected]>

vixentael added 2 commits July 29, 2020 18:10

updated swift examples code to showcase keygen and passphrase APIs

eea28a7

imrpove changelog

e82b24a

vixentael requested a review from Lagovas as a code owner July 29, 2020 15:16

vixentael commented Jul 29, 2020

View reviewed changes

vixentael requested a review from ilammy July 29, 2020 15:18

vixentael added enhancement O-iOS 📱 Operating system: iOS W-SwiftThemis 🔶 Wrapper: SwiftThemis, Swift API labels Jul 29, 2020

ilammy approved these changes Jul 29, 2020

View reviewed changes

vixentael added 3 commits July 30, 2020 00:01

small fixes according to pr review

73f3328

update macos example

a460bbd

update objc examples

c5eb3f5

vixentael requested a review from ilammy July 29, 2020 22:28

updated changelog

04124b4

vixentael changed the title ~~Update Swift examples code to showcase keygen and passphrase APIs~~ Update Swift, ObjC examples code to showcase keygen and passphrase APIs Jul 29, 2020

vixentael added W-ObjCThemis 🎨 Wrapper: ObjCThemis, Objective-C API M-Carthage Package manager: Carthage, Objective-C and Swift, iOS and macOS M-CocoaPods Package manager: CocoaPods, Objective-C and Swift, iOS and macOS O-macOS 💻 Operating system: macOS labels Jul 29, 2020

vixentael commented Jul 29, 2020

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

vixentael commented Jul 29, 2020

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Apply suggestions from code review

5ada08f

upd changelog

ilammy reviewed Jul 30, 2020

View reviewed changes

Apply suggestions from code review

058ee16

Co-authored-by: Alexei Lozovsky <[email protected]>

ilammy approved these changes Jul 30, 2020

View reviewed changes

vixentael merged commit 850f9ab into master Jul 30, 2020

vixentael deleted the vxxtl/update-swift-examples branch July 30, 2020 10:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Swift, ObjC examples code to showcase keygen and passphrase APIs #688

Update Swift, ObjC examples code to showcase keygen and passphrase APIs #688

vixentael commented Jul 29, 2020 •

edited by iamnotacake

Loading

vixentael Jul 29, 2020

ilammy Jul 29, 2020

ilammy left a comment

ilammy Jul 29, 2020

ilammy Jul 29, 2020

ilammy Jul 29, 2020

vixentael Jul 29, 2020

ilammy Jul 29, 2020

vixentael Jul 29, 2020

vixentael Jul 29, 2020 •

edited

Loading

vixentael commented Jul 29, 2020

ilammy Jul 30, 2020

vixentael Jul 30, 2020

ilammy Jul 30, 2020

		@@ -1,2 +1,2 @@
		github "cossacklabs/themis" "0.13.0"
		github "cossacklabs/themis" "gothemis/v0.13.0"

		<label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="Copyright (c) 2015-2019 Cossack Labs. All rights reserved." textAlignment="center" lineBreakMode="tailTruncation" numberOfLines="0" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="SDJ-TG-gQB">
		<label opaque="NO" userInteractionEnabled="NO" contentMode="left" horizontalHuggingPriority="251" verticalHuggingPriority="251" text="Copyright (c) 2015-2020 Cossack Labs. All rights reserved." textAlignment="center" lineBreakMode="tailTruncation" numberOfLines="0" baselineAdjustment="alignBaselines" adjustsFontSizeToFit="NO" translatesAutoresizingMaskIntoConstraints="NO" id="SDJ-TG-gQB">

Project	Code style
`docs/examples/objc/iOS-Carthage`	1️⃣ `NSString *message`
`docs/examples/objc/iOS-CocoaPods`	2️⃣ `NSString * message`
`docs/examples/objc/macOS-Carthage`	1️⃣ `NSString *message`
`docs/examples/Themis-server/Obj-C`	2️⃣ `NSString * base64Body`
`src/wrappers/themis/Obj-C/objcthemis`	1️⃣ `NSMutableData *unwrappedMessage`
`tests/objcthemis/objthemis`	2️⃣ `NSString * sharedSecret`

Update Swift, ObjC examples code to showcase keygen and passphrase APIs #688

Update Swift, ObjC examples code to showcase keygen and passphrase APIs #688

Conversation

vixentael commented Jul 29, 2020 • edited by iamnotacake Loading

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ilammy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vixentael Jul 29, 2020 • edited Loading

Choose a reason for hiding this comment

vixentael commented Jul 29, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vixentael commented Jul 29, 2020 •

edited by iamnotacake

Loading

vixentael Jul 29, 2020 •

edited

Loading