feat(#162): moved repo type

.gitignore

@@ -22,3 +22,5 @@ github-mirror/.gitignore
 github-mirror/git_push.sh
 github-mirror/README.md
 github-mirror/.openapi-generator-ignore
+github-mirror/**/src
+node_modules

Cargo.toml

@@ -23,7 +23,8 @@
 members = [
     "server",
     "cli",
-    "github-mirror"
+    "github-mirror",
+    "types",
 ]
 resolver = "1"
 

github-mirror/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "openapi"
+version = "1.1.4"
+authors = ["OpenAPI Generator team and contributors"]
+description = "GitHub's v3 REST API."
+license = "MIT"
+edition = "2021"
+
+[dependencies]
+serde = { version = "^1.0", features = ["derive"] }
+serde_json = "^1.0"
+url = "^2.5"
+uuid = { version = "^1.8", features = ["serde", "v4"] }
+reqwest = { version = "^0.12", features = ["json", "multipart"] }

package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "kill-port": "^2.0.1"
+  }
+}

server/Cargo.toml

@@ -38,7 +38,8 @@ path = "src/lib.rs"
 workspace = true
 
 [dependencies]
-openapi = { path = "../github-mirror", version = "1.1.4" }
+openapi = { path = "../github-mirror" }
+types = { path = "../types" }
 anyhow = "1.0.86"
 serde = { version = "1.0.203", features = ["derive"] }
 serde_json = "1.0.117"

server/src/objects/mod.rs

@@ -26,6 +26,6 @@ pub mod github;
 /// JSON objects.
 pub mod json;
 /// GitHub repository.
-pub mod repo;
+pub mod repo_ops;
 /// GitHub user.
 pub mod user;

server/src/objects/repo.rs → server/src/objects/repo_ops.rs

@@ -20,44 +20,49 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 use crate::objects::user::User;
-use serde::{Deserialize, Serialize};
+use types::types::repo::Repo;
 
-/// Repo.
-#[derive(Clone, Debug, Serialize, Deserialize)]
-pub struct Repo {
-    /// Repo name.
-    pub name: String,
-    /// Private or not?
-    pub private: bool,
-}
-
-impl Repo {
+#[allow(dead_code)]
+// @todo #162:25min Remove allow dead code.
+//  Let's remove this suppression. Suggestion is
+//  write a test that will use public function.
+//  There is something with trait usage
+//  Do not forget to remove this puzzle.
+pub(crate) trait RepoOperations {
     /// New repo.
     /// `name` Repo name
     /// `private` Private repo or not
-    pub fn new(name: String, private: bool) -> Repo {
-        Repo { name, private }
-    }
+    fn new(name: String, private: bool) -> Self;
 
     /// New public repo.
     /// `name` Repo name
-    pub fn public(name: String) -> Repo {
+    fn public(name: String) -> Self;
+
+    /// Create for.
+    fn create_for(self, owner: &mut User);
+}
+
+impl RepoOperations for Repo {
+    fn new(name: String, private: bool) -> Self {
+        Repo { name, private }
+    }
+
+    fn public(name: String) -> Self {
         Repo {
             name,
             private: false,
         }
     }
 
-    /// Create for.
-    pub fn create_for(self, owner: &mut User) {
+    fn create_for(self, owner: &mut User) {
         owner.repos.push(self)
     }
 }
 
 #[cfg(test)]
 mod tests {
     use crate::objects::fakehub::FakeHub;
-    use crate::objects::repo::Repo;
+    use crate::objects::repo_ops::{Repo, RepoOperations};
     use anyhow::Result;
     use hamcrest::{equal_to, is, HamcrestMatcher};
 

server/src/objects/user.rs

@@ -24,12 +24,12 @@ use crate::handlers::cursor::Cursor;
 use crate::handlers::sh_cursor::ShCursor;
 use crate::objects::fakehub::FakeHub;
 use crate::objects::github::GitHub;
-use crate::objects::repo::Repo;
 use anyhow::Result;
 use log::info;
 use rand::Rng;
 use serde::{Deserialize, Serialize};
 use serde_json::{Map, Number, Value};
+use types::types::repo::Repo;
 
 /// GitHub user.
 #[derive(Clone, Debug, Serialize, Deserialize)]

types/Cargo.toml

@@ -0,0 +1,36 @@
+# The MIT License (MIT)
+#
+# Copyright (c) 2024 Aliaksei Bialiauski
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+[package]
+name = "types"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+serde = { version = "1.0.210", features = ["derive"] }
+serde_json = "1.0.128"
+uuid = { version = "1.10.0", features = ["v4"] }
+
+[lints]
+workspace = true
+
+[lib]
+path = "src/lib.rs"

types/src/lib.rs

@@ -0,0 +1,30 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+/*!
+The types.
+*/
+/// The types.
+pub mod types;
+// @todo #162:25min Remove dumb documentation.
+//  Let's remove this ugly docs. Looks like there is
+//  some bug with linting the module docs. Do not
+// forget to remove this puzzle.

types/src/types/github.rs

@@ -0,0 +1,35 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+use crate::types::user::User;
+use std::collections::HashMap;
+use uuid::Uuid;
+
+/// GitHub.
+#[derive(Clone)]
+pub struct GitHub {
+    /// GitHub ID.
+    pub id: Uuid,
+    /// GitHub URL.
+    pub name: String,
+    /// Users inside.
+    pub users: HashMap<String, User>,
+}

types/src/types/mod.rs

@@ -0,0 +1,27 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+/// The GitHub.
+pub mod github;
+/// The Repo.
+pub mod repo;
+/// The User.
+pub mod user;

types/src/types/repo.rs

@@ -0,0 +1,31 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+use serde::{Deserialize, Serialize};
+
+/// Repo.
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct Repo {
+    /// Repo name.
+    pub name: String,
+    /// Private or not?
+    pub private: bool,
+}

types/src/types/user.rs

@@ -0,0 +1,35 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2024 Aliaksei Bialiauski
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included
+// in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+use crate::types::repo::Repo;
+use serde::{Deserialize, Serialize};
+use serde_json::{Map, Value};
+
+/// GitHub user.
+#[derive(Clone, Debug, Serialize, Deserialize)]
+pub struct User {
+    /// Login, a.k.a. username.
+    pub login: String,
+    /// Repos.
+    pub repos: Vec<Repo>,
+    /// Extra information.
+    pub extra: Map<String, Value>,
+}