Merge pull request #10 from srikanthkm/master

Changes to include IBM Core SDK, documentation

Author: jojustin

.pre-commit-config.yaml

@@ -11,7 +11,7 @@ repos:
   # You are encouraged to use static refs such as tags, instead of branch name
   #
   # Running "pre-commit autoupdate" would automatically updates rev to latest tag
-  rev: 0.13.1+ibm.36.dss
+  rev: 0.13.1+ibm.39.dss
   hooks:
     -   id: detect-secrets # pragma: whitelist secret
         # Add options for detect-secrets-hook binary. You can run `detect-secrets-hook --help` to list out all possible options.

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$|go.sum|examples/SampleApp/go.sum|vendor",
     "lines": null
   },
-  "generated_at": "2021-05-27T19:00:52Z",
+  "generated_at": "2021-07-01T06:28:41Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -70,31 +70,23 @@
         "hashed_secret": "d4c3d66fd0c38547a3c7a4c6bdc29c36911bc030",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 63,
-        "type": "Secret Keyword",
-        "verified_result": null
-      },
-      {
-        "hashed_secret": "a94906aadfc6ddd1659ef976cf1b5ecae197b9a3",
-        "is_secret": false,
-        "is_verified": false,
-        "line_number": 131,
+        "line_number": 74,
         "type": "Secret Keyword",
         "verified_result": null
       }
     ],
-    "lib/internal/utils/Metering.go": [
+    "lib/internal/utils/UrlBuilder.go": [
       {
-        "hashed_secret": "d4c3d66fd0c38547a3c7a4c6bdc29c36911bc030",
+        "hashed_secret": "f75b33f87ffeacb3a4f793a09693e672e07449ff",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 86,
+        "line_number": 80,
         "type": "Secret Keyword",
         "verified_result": null
       }
     ]
   },
-  "version": "0.13.1+ibm.36.dss",
+  "version": "0.13.1+ibm.39.dss",
   "word_list": {
     "file": null,
     "hash": null

CODE_OF_CONDUCT.md

@@ -0,0 +1,62 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
+participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
+disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education,
+socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
+appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
+project or its community. Examples of representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed representative at an online or offline
+event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
+[email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed
+necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to
+the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
+repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available
+at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.MD

@@ -0,0 +1,87 @@
+# Contributing
+
+Review the following guidelines for submitting questions, issues, or changes to this repository.
+
+## Questions
+
+If you have questions about using the IBM Cloud App Configuration SDKs, you can ask questions in
+[Stack Overflow](https://stackoverflow.com/questions/tagged/ibm-appconfiguration). Be sure to include
+the `ibm-appconfiguration` tags.
+
+## Coding Style
+
+The SDK follows the Go coding conventions documented [here](https://golang.org/doc/effective_go.html). 
+
+### Running Linter
+Linter is a tool that analyzes source code to flag programming errors, bugs, stylistic errors, and suspicious constructs.
+Golint is a useful Go linting tool that prints out coding style mistakes. 
+
+Perform the following steps to run "golint" on this SDK :-
+- Ensure that local GOPATH and GOBIN are fully setup by using the go env command.
+- Install the package by using the command 
+    ```
+    go get -u golang.org/x/lint/golint
+    ```
+- Verify the installation by running 'ls $GOBIN | grep golint' command.
+- To run "golint" on the SDK, run the following from the SDK root directory.
+    ```
+    make lint
+    ```
+
+## Issues
+
+If you encounter an issue with Go SDK, you're welcome to submit
+a [bug report](https://github.com/IBM/appconfiguration-go-sdk/issues). Before that, please search for similar issues. It's possible somebody has encountered this issue already.
+
+## Pull Requests
+
+If you want to contribute to the repository, follow these steps:
+
+1. Fork the repository
+2. Develop and test your code changes:
+    - To build/test: `make test`
+3. Please add one or more tests to validate your changes.
+4. Make sure everything builds/tests cleanly
+5. Check your code for lint issues:
+    ```
+    make lint
+    ```
+6. Commit your changes
+7. Push to your fork and submit a pull request to the `master` branch
+
+## Running the tests
+
+The tests within the SDK consists of unit tests.
+
+To run the test, run the following from the root folder:
+
+```
+make test
+```
+
+# Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+   have the right to submit it under the open source license
+   indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+   of my knowledge, is covered under an appropriate open source
+   license and I have the right under that license to submit that
+   work with modifications, whether created in whole or in part
+   by me, under the same open source license (unless I am
+   permitted to submit under a different license), as indicated
+   in the file; or
+
+(c) The contribution was provided directly to me by some other
+   person who certified (a), (b) or (c) and I have not modified
+   it.
+
+(d) I understand and agree that this project and the contribution
+   are public and that a record of the contribution (including all
+   personal information I submit with it, including my sign-off) is
+   maintained indefinitely and may be redistributed consistent with
+   this project or the open source license(s) involved.
+

Makefile

@@ -0,0 +1,17 @@
+lint:
+	golint lib && golint lib/internal/models && golint lib/internal/utils && golint lib/internal/messages && golint lib/internal/constants && golint examples
+
+testLib:
+	cd lib/ && go test -coverprofile=coverage.out
+
+testLibModels:
+	cd lib/internal/models && go test -coverprofile=coverage.out 
+	
+testLibUtils:
+	cd lib/internal/utils && go test -coverprofile=coverage.out 
+
+test:
+	make testLib
+	make testLibModels
+	make testLibUtils
+	go test --coverprofile=coverage.out ./... && go tool cover -func=coverage.out

README.md

@@ -25,7 +25,7 @@ properties for distributed applications centrally.
 
 ## Installation
 
-The current version of this SDK: 0.1.0
+The current version of this SDK: 0.1.1
 
 There are a few different ways to download and install the IBM App Configuration Go SDK project for use by your Go
 application:
@@ -93,17 +93,13 @@ appConfiguration.SetContext("airlines-webapp", "dev", AppConfiguration.ContextOp
 - LiveConfigUpdateEnabled: Set this value to `false` if the new configuration values shouldn't be fetched from the
   server. Make sure to provide a proper JSON file in the path. By default, this value is enabled.
 
-### Permissions required by SDK
-  Add write permission for `non-root` users to `appconfiguration.json` file which is used as cache in AppConfiguration SDK.
-  AppConfiguration cache location will be the application root folder.
-
 ## Get single feature
 
 ```go
 feature, err := appConfiguration.GetFeature("online-check-in")
 if err == nil {
     fmt.Println("Feature Name", feature.GetFeatureName())
-    fmt.Println("Feature Id", feature.GetFeatureId())
+    fmt.Println("Feature Id", feature.GetFeatureID())
     fmt.Println("Feature Type", feature.GetFeatureDataType())
 
     if (feature.IsEnabled()) {
@@ -121,7 +117,7 @@ features := appConfiguration.GetFeatures()
 feature := features["online-check-in"]
 
 fmt.Println("Feature Name", feature.GetFeatureName())
-fmt.Println("Feature Id", feature.GetFeatureId())
+fmt.Println("Feature Id", feature.GetFeatureID())
 fmt.Println("Feature Type", feature.GetFeatureDataType())
 fmt.Println("Feature is enabled", feature.IsEnabled())
 ```
@@ -147,7 +143,7 @@ featureVal := feature.GetCurrentValue(entityId, entityAttributes)
 property, err := appConfiguration.GetProperty("check-in-charges")
 if err == nil {
     fmt.Println("Property Name", property.GetPropertyName())
-    fmt.Println("Property Id", property.GetPropertyId())
+    fmt.Println("Property Id", property.GetPropertyID())
     fmt.Println("Property Type", property.GetPropertyDataType())
 }
 ```
@@ -159,7 +155,7 @@ properties := appConfiguration.GetProperties()
 property := properties["check-in-charges"]
 
 fmt.Println("Property Name", property.GetPropertyName())
-fmt.Println("Property Id", property.GetPropertyId())
+fmt.Println("Property Id", property.GetPropertyID())
 fmt.Println("Property Type", property.GetPropertyDataType())
 ```
 

examples/go.mod

@@ -3,6 +3,6 @@ module examples
 go 1.16
 
 require (
-	github.com/IBM/appconfiguration-go-sdk v0.1.0
+	github.com/IBM/appconfiguration-go-sdk v0.1.1
 	github.com/gorilla/mux v1.7.2
-)
+)

examples/go.sum

@@ -21,4 +21,4 @@ golang.org/x/sys v0.0.0-20201119102817-f84b799fce68 h1:nxC68pudNYkKU6jWhgrqdreuF
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

examples/main.go

@@ -19,7 +19,7 @@ func main() {
 	appConfiguration := AppConfiguration.GetInstance()
 	appConfiguration.Init(AppConfiguration.REGION_US_SOUTH, "<guid>", "<apikey>")
 	appConfiguration.SetContext("<collectionId>", "<environmentId>")
-	entityId := "user123"
+	entityID := "user123"
 	entityAttributes := make(map[string]interface{})
 	entityAttributes["city"] = "Bangalore"
 	entityAttributes["radius"] = 60
@@ -28,19 +28,19 @@ func main() {
 	feature, err := appConfiguration.GetFeature("<featureId>")
 	if err == nil {
 		fmt.Println("Feature Name:", feature.GetFeatureName())
-		fmt.Println("Feature Id:", feature.GetFeatureId())
+		fmt.Println("Feature Id:", feature.GetFeatureID())
 		fmt.Println("Feature Data type:", feature.GetFeatureDataType())
 		fmt.Println("Is Feature enabled?", feature.IsEnabled())
-		fmt.Println("Feature evaluated value is:", feature.GetCurrentValue(entityId, entityAttributes))
+		fmt.Println("Feature evaluated value is:", feature.GetCurrentValue(entityID, entityAttributes))
 	}
 
 	fmt.Println("\n\nPROPERTY OPERATIONS\n")
 	property, err := appConfiguration.GetProperty("<propertyId>")
 	if err == nil {
 		fmt.Println("Property Name:", property.GetPropertyName())
-		fmt.Println("Property Id:", property.GetPropertyId())
+		fmt.Println("Property Id:", property.GetPropertyID())
 		fmt.Println("Property Data type:", property.GetPropertyDataType())
-		fmt.Println("Property evaluated value is:", property.GetCurrentValue(entityId, entityAttributes))
+		fmt.Println("Property evaluated value is:", property.GetCurrentValue(entityID, entityAttributes))
 	}
 	//whenever the configurations get changed/updated on the app configuration service instance the function inside this listener is triggered.
 	//So, to keep track of live changes to configurations use this listener.

go.mod

@@ -3,8 +3,16 @@ module github.com/IBM/appconfiguration-go-sdk
 go 1.16
 
 require (
-	github.com/go-resty/resty/v2 v2.4.0
+	github.com/IBM/go-sdk-core/v5 v5.5.1
+	github.com/google/uuid v1.2.0 // indirect
 	github.com/gorilla/websocket v1.4.2
+	github.com/mitchellh/mapstructure v1.4.1 // indirect
 	github.com/robfig/cron v1.2.0
 	github.com/sirupsen/logrus v1.7.0
+	github.com/stretchr/testify v1.6.1
+	golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4 // indirect
+	golang.org/x/sys v0.0.0-20210616094352-59db8d763f22 // indirect
+	golang.org/x/text v0.3.6 // indirect
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
 )